Patch Set 1:

(1 comment)

https://gerrit.osmocom.org/#/c/4340/1/include/osmocom/core/utils.h
File include/osmocom/core/utils.h:

Line 90:  * \param[inout] dest  char* to re-/allocate and append to.
> good catch. I actually thought it's "inout" and we most likely have other p
I looked in 
https://osmocom.org/projects/cellular-infrastructure/wiki/Guidelines_for_API_documentation
 and it says "inout". In my currently checked out repositories, we have 35 
instances of "inout" and only 17 of "in,out".
But looking at http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html it 
says "in,out". I changed the wiki page now.

However, when I look at the rendered API doc for msgb_resize_area(), which says 
"inout" in the source, it is shown as "in,out" at 
http://ftp.osmocom.org/api/latest/libosmocore/core/html/group__msgb.html#gab1ffdec5c9aa14709b9b10b0c3ad3612

So, in practical terms, it seems to not matter whether we write inout or in,out.


-- 
To view, visit https://gerrit.osmocom.org/4340
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: Ic9dba0e4a1eb5a7dc3cee2f181b9024ed4fc7005
Gerrit-PatchSet: 1
Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Owner: Neels Hofmeyr <[email protected]>
Gerrit-Reviewer: Harald Welte <[email protected]>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: Max <[email protected]>
Gerrit-Reviewer: Neels Hofmeyr <[email protected]>
Gerrit-HasComments: Yes

Reply via email to