[lwip-devel] [task #14052] Update doxygen documentation

[Marco Veeneman]

Follow-up Comment #1, task #14052 (project lwip):

Is there a reason for not documenting the direction of function parameters?
See https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdparam

Regarding item 2, you can specify aliases in the doxyfile, see the ALIASES
item. 
You can for example specify 'api' and 'notapi' and use it in the comments as
@api and @notapi. 

Something like:
ALIASSES = \
"api=Normal API, this function can be used by the programmer."\
"notapi=Internal API, this function is only used internally."

The drawback of this method is that the internal APIs are still documented.

Another way is using the @cond and @endcond commands. See
https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdcond

Something like:
@cond INTERNAL
<internal code here>
@endcond

If you set ENABLED_SECTIONS = INTERNAL in the doxyfile, then the internal APIs
are also documented.

This way you can create documentation for the all APIs but also for external
APIs only.

    _______________________________________________________

Reply to this item at:

  <http://savannah.nongnu.org/task/?14052>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.nongnu.org/