For the HTML output brief descriptions are also use to provide tooltips at places where an item is referenced. An "in body" description can also act as a detailed description or can describe a collection of implementation details. Having more than one brief or detailed description is allowed (but not recommended, as the order in which the descriptions will appear is not specified).Īs the name suggest, a brief description is a short one-liner, whereas the detailed description provides longer, more detailed documentation. For methods and functions there is also a third type of description, the so called "in body" description, which consists of the concatenation of all comment blocks found within the body of the method or function. For Python, VHDL, Fortran, and Tcl code there are different comment conventions, which can be found in sections Special documentation blocks in Python, Special documentation blocks in VHDL, Special documentation blocks in Fortran, and Documentation blocks in Tcl respectively.įor each code item there are two (or in some cases three) types of descriptions, which together form the documentation: a brief description and detailed description, both are optional. / input/output (usu.A special documentation block is a C or C style comment block with some additional markings, so doxygen knows it is a piece of documentation that needs to end up in the generated documentation. / \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 Source files or directories can be specified using the EXAMPLEPATH tag of doxygen's configuration file. The command takes the name of an include file as an argument. / \param var2 Description of variable two, an input This command can be used to include a source file as a block of code. / \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. The doxygen manual is available for specific questions about Doxygen. How should I properly use _attribute_ ((format (printf, x, y))) inside a class method in C ? Python Python Docstring Documentation Formatting of the Docstring Text Preamble for each source file Complete Python Example LSST uses doxygen as its primary source code documentation generator tool.How to use formatting strings in user-defined functions?.Documentation for GCC's super useful printf format attribute:.Other code examples demonstrating Doxygen usage:.Official Doxygen documentation for the param special command:.Is that an in or in/out parameter? Doxygen, C .See these references for more details
0 Comments
Leave a Reply. |