[RTEMS Project] #3721: Doxygen param "in/out" attributes not matching function behavior
RTEMS trac
trac at rtems.org
Fri Mar 8 15:10:30 UTC 2019
#3721: Doxygen param "in/out" attributes not matching function behavior
-------------------------------+---------------------
Reporter: Jens Schweikhardt | Owner: (none)
Type: enhancement | Status: new
Priority: normal | Milestone:
Component: doc | Version: 5
Severity: normal | Resolution:
Keywords: | Blocked By:
Blocking: |
-------------------------------+---------------------
Comment (by Joel Sherrill):
This method was not the best example to pick to back up your case. The
size parameter is used as *size for the size of the caller's buffer and
filled in on output with the size of the message actually received.
https://git.rtems.org/rtems/tree/cpukit/score/src/coremsgseize.c#n46
This particular case is indeed in/out.
Others may indicate the thinking that the pointer was an input and
*pointer was the output.
--
Ticket URL: <http://devel.rtems.org/ticket/3721#comment:1>
RTEMS Project <http://www.rtems.org/>
RTEMS Project
More information about the bugs
mailing list