[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):

 If I had to devise a (rough?) guideline:

 1) only pointer parameters are annotated (since scalars are [in] by
 language definition)
 2) [in] indicates that the pointer must point to an initialized object (it
 may be dereferenced by the directive)
 3) [out] indicates that the object pointed to may be written by the
 directive
 4) [inout] If both 2) and 3) apply.

 This is basically how I interpret these annotations from the Interface
 Definition Languages from a past life where I used CORBA with a C binding.
 Word-smithing suggestions welcome.

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