*! \fn const char *Test::member(char c,int n) If (round) braces are used the argument extends until the end of the line on which the command was found. If braces are used the argument is a single word. Some commands have one or more arguments. / input/output (usu.Doxygen manual: Special Commands Special CommandsĪll commands in the documentation start with a backslash ( \) or an at-sign ( If you prefer you can replace all commands starting with a backslash below, by their counterparts that start with an at-sign. ![]() / \param var3 Description of variable three, an output ( Void myFunc(int var1, int var2, int* var3, int* var4)Īnd here's this shorter version again now with \ again instead of /// \brief A brief one or two line description of the function. / var4 Description of variable four, an / var3 Description of variable three, an output / var2 Description of variable two, an input / var1 Description of variable one, an input You may also use instead of \: /// A brief one or two line description of the function. var3 or var4 are NULL pointers, which means they can't be My_enum_t myFunc(int var1, int var2, int* var3, int* var4) / value is read and used, but then it is also updated by / \param var4 Description of variable four, an / \param var3 Description of variable three, an output / \param var2 Description of variable two, an input / \param var1 Description of variable one, an input / \note An important note the user should be aware of-perhaps many (Copied from my eRCaGuy_dotfiles project here)įull Doxygen function header example: /// \brief A brief one or two line description of the function.
0 Comments
Leave a Reply. |