Use the 'back reference' to document enumerator values:Įnum_one **< less than marker tells doxygen to use this line to document enum_one. Use the param command to describe function parameters in the text. If a doxygen documentation after a member is reversed, the comment after the member should use the spe cial doxygen tag used to mark a documentation after a member. Use :: at the start of a function or structure to link to the page for that function in the doxygen documentation. This feature only works in import-code-only mode. for a sublist:Įnd the list with a blank line. To create a numbered list, use -# e.g.The rest of the documentation will then be shown in the body of the doxygen page.Ĭommands may begin with \ or Start a line with a hyphen to start a list - the indent determines the nesting of the list: To put a description with each function or structure, use '\brief' End the brief description with a blank line. Doxygen accepts commands using a backslash. However, for Doxygen comments, my approach is to simply go to my notes file here and manually copy-paste a Doxygen header from there to my code, then update it manually. You can use an extra slash /// or an extra asterisk. For normal comment blocks, I can hard wrap a comment block to my first column-width 'rulers' setting in Sublime Text by pressing Alt Q. Doxygen will extract comments starting with '-'. \brief one-liner summary of the file purposeĮvery doxygen comment block starts with an adapted comment marker. For VHDL a comment normally start with '-'. If your declarations are in separate files, like private header files, a simple block can still be linked into doxygen as long as the file is identified to doxygen using a '\file' section: This will enable doxygen to link all parameter types to the declarations every time the type is used in a function - very helpful to new developers. Block Comments You should use Doxygen block comments with both brief and detailed descriptions to document code by default. Doxygen reference documentation The Doxygen manual Comments after an element should be used only for documenting members of enumeration types, structures, and unions.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |