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. A special documentation block is a C or C++ style comment block with some additional markings, so doxygen knows it is a piece. At the top of the function, type: / Press. warning The objects of the array must be NSFNanoObjectProtocol-compliant. param outError is used if an error occurs. It seems there is no way to configure Doxygen comment generation in Eclipse. In our project we use triple slash /// to generate doxygen comments. However it appears to only act on / / comments for auto generating. Go to C/C++ -> Editors -> Documentation Tool Comments: Doxygen.
DOXYGEN METHOD COMMENT CODE
For Python and VHDL code there are a different comment conventions, which can be found in section Special documentation blocks in Python and Special documentation blocks in VHDL 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. Automatically Insert Function Doxygen Comment Block Add your function with optional return value and parameters. doxygen commented on param theObject the object to be removed from the document store. It seems Eclipse has Doxygen support somewhat natively now. 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.
0 kommentar(er)
