![]() ![]() / \param var4 Description of variable four, an input/output (usu.Step 0: Check if doxygen supports your programming/hardware description languageįirst, assure that your programming/hardware description language has a reasonable chance of being recognized by doxygen. 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 input/output (usu. / var3 Description of variable three, an output (usu. / 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 dereferenced My_enum_t myFunc(int var1, int var2, int* var3, int* var4) / it is also updated by the function at some point / pointer) since its initial value is read and used, but then / \param var4 Description of variable four, an input/output (usu. / \param var3 Description of variable three, an output (usu. / \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 lines. (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. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |