Change in libosmocore[master]: core/linuxlist.h: fix and unify Doxygen documentation

Pau Espin Pedrol gerrit-no-reply at lists.osmocom.org
Mon Mar 25 14:50:46 UTC 2019


Pau Espin Pedrol has posted comments on this change. ( https://gerrit.osmocom.org/13398 )

Change subject: core/linuxlist.h: fix and unify Doxygen documentation
......................................................................


Patch Set 1:

(5 comments)

https://gerrit.osmocom.org/#/c/13398/1/include/osmocom/core/linuxlist.h
File include/osmocom/core/linuxlist.h:

https://gerrit.osmocom.org/#/c/13398/1/include/osmocom/core/linuxlist.h@50
PS1, Line 50: /*! Define a new llist_head pointing to another llist_head.
another is confusing here, specially because immediatelly afterwards it' used to point to itself in LLIST_HEAD. So better use "a given" instead of "other".


https://gerrit.osmocom.org/#/c/13398/1/include/osmocom/core/linuxlist.h@69
PS1, Line 69:  * Insert a new entry between two known consecutive entries.
No need for extra line. You can start it with "/*! Insert", see functions below.


https://gerrit.osmocom.org/#/c/13398/1/include/osmocom/core/linuxlist.h@85
PS1, Line 85:  *  \param _new a new entry to be added.
"the entry to be added".


https://gerrit.osmocom.org/#/c/13398/1/include/osmocom/core/linuxlist.h@86
PS1, Line 86:  *  \param head head of linked list to add it after.
"add it after" is quite misleading here. Would be a lot clearer saying " linked list head to prepend the element to". I see nowhere the word "prepend" being used, and imho it's the one really explaining in an easy way what this function does.


https://gerrit.osmocom.org/#/c/13398/1/include/osmocom/core/linuxlist.h@344
PS1, Line 344:         	
whitespace, we can remove it in this commit or add an extra one.



-- 
To view, visit https://gerrit.osmocom.org/13398
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: Iac67bdb9d5fbf7c222d04858967337f2428d6a94
Gerrit-Change-Number: 13398
Gerrit-PatchSet: 1
Gerrit-Owner: Vadim Yanitskiy <axilirator at gmail.com>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder (1000002)
Gerrit-CC: Pau Espin Pedrol <pespin at sysmocom.de>
Gerrit-Comment-Date: Mon, 25 Mar 2019 14:50:46 +0000
Gerrit-HasComments: Yes
Gerrit-HasLabels: No
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20190325/09c44241/attachment.html>


More information about the gerrit-log mailing list