SamatsWiki

Doxygen and Javadoc style stuff

Doxygen

Tag cheat sheat

Reference: Doxygen special commands

tag

Meaning

\a <word>

Argument (i.e. function with parameters x and y called with arguments 1 and 2)

\code{.py} <multi-line source code> \endcode

Source code snippet

\p <word>

Parameter (refers to actual variables, i.e. a function takes parameters x and y)

SamatsWiki: CodingStyle/Doxygen (last edited 2018-06-21 08:18:21 by SamatJain)