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. The next section presents the various styles supported by doxygen.įor Python, VHDL, and Fortran code there are different commenting conventions, which can be found in sections Comment blocks in Python, Comment blocks in VHDL, and Comment blocks in Fortran respectively.Ĭomment blocks for C-like languages (C/C++/C#/Objective-C/PHP/Java)įor each entity in the code there are two (or in some cases three) types of descriptions, which together form the documentation for that entity a brief description and detailed description, both are optional.
#Doxygen tutorial how to
How to put comments in your code such that doxygen incorporates them in the documentation it generates.
0 kommentar(er)
