Change in libosmocore[master]: add API doc for LOGPFSM* macros

This is merely a historical archive of years 2008-2021, before the migration to mailman3.

A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.

Neels Hofmeyr gerrit-no-reply at lists.osmocom.org
Thu Dec 20 22:43:28 UTC 2018


Neels Hofmeyr has posted comments on this change. ( https://gerrit.osmocom.org/12384 )

Change subject: add API doc for LOGPFSM* macros
......................................................................


Patch Set 1:

(1 comment)

https://gerrit.osmocom.org/#/c/12384/1/include/osmocom/core/fsm.h
File include/osmocom/core/fsm.h:

https://gerrit.osmocom.org/#/c/12384/1/include/osmocom/core/fsm.h@123
PS1, Line 123: osmo_fsm_inst
> \ref
I'm personally no fan of \ref or \a or such things in API doc. For me it's fine to have a doxygen generated html that someone may read (though I don't know who). But IMHO it's not worth it to break the flow of normal C-file API reading. I know laforge says he's not even seeing those \refs anymore. But for me they are quite distracting ... I just want to write and read English with names; can't doxygen figure out on its own which of the words are references?



-- 
To view, visit https://gerrit.osmocom.org/12384
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-MessageType: comment
Gerrit-Change-Id: I3bf6500889aa58195f50a726dec0876c0c2baec3
Gerrit-Change-Number: 12384
Gerrit-PatchSet: 1
Gerrit-Owner: Neels Hofmeyr <nhofmeyr at sysmocom.de>
Gerrit-Reviewer: Jenkins Builder (1000002)
Gerrit-Reviewer: Neels Hofmeyr <nhofmeyr at sysmocom.de>
Gerrit-Reviewer: Vadim Yanitskiy <axilirator at gmail.com>
Gerrit-Comment-Date: Thu, 20 Dec 2018 22:43:28 +0000
Gerrit-HasComments: Yes
Gerrit-HasLabels: No
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20181220/55c51b29/attachment.htm>


More information about the gerrit-log mailing list