Use the 'back reference' to document enumerator values:Įnum_one **< less than marker tells doxygen to use this line to document enum_one. The comments are included in the header files (.h) files. Use the param command to describe function parameters in the text. To use Doxygen, you write comments in code using the format that Doxygen understands. Use :: at the start of a function or structure to link to the page for that function in the doxygen documentation. for a sublist:Įnd the list with a blank line. to provide a brief documentation for such functions in the header file. To create a numbered list, use -# e.g. The script ROOTSYS/documentation/doxygen/makeinput.sh defines the INPUT tag in.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. Commands start with or \ E.g: file, brief, \file, \brief. Each intermediate line has 'space space' but this is optional. Doxygen accepts commands using a backslash. I am going to describe a style to write doxygen comments, but there are other styles too. You can use an extra slash /// or an extra asterisk. \brief one-liner summary of the file purposeĮvery doxygen comment block starts with an adapted comment marker. 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: Update is done on each documentation build by invoking Sphinx extension : espextensions/rundoxygen.py for all header files listed in the INPUT statement of. Source files or directories can be specified using the EXAMPLEPATH tag of doxygens configuration file. Commands start with or E.g: file, brief, file, brief. Each intermediate line has space space but this is optional. These included in the header file along with the declaration of the functions. I prefer to use Doxywizard to generate the Doxygen file for. I am going to describe a style to write doxygen comments, but there are other styles too. Template Doxygen Page for New Category of Source Files Template page for. Such graphs can be generated easily using Doxygen. Obtaining a directed graph of which header files include a given header file can help in understanding the situation better. 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. In large projects, it quickly becomes difficult to see which header files include a given header file and how. Doxygen reference documentation The Doxygen manual.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |