[RTEMS Project] #3721: Doxygen param "in/out" attributes not matching function behavior

[RTEMS trac]

#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 Jens Schweikhardt):

 OK, from the description it was not clear that size is actually [inout].
 Maybe there's room for improvement as well.

 As for "Others may indicate" I would argue that in that case "in" is
 redundant, or even pointless, since in C parameters are always passed by
 value, so can only be "in" by language definition.

 Nit-pick: the coremsgseize.c you reference says "@brief Size" where it
 meant "Seize". :-)

--
Ticket URL: <http://devel.rtems.org/ticket/3721#comment:2>
RTEMS Project <http://www.rtems.org/>
RTEMS Project