Doxygen Cheatsheet. A quick cheatsheet for Doxygen, adapted from . File header. /** \file * Description of the file * * \author Olivier Mehani
|Published (Last):||16 November 2004|
|PDF File Size:||8.20 Mb|
|ePub File Size:||8.20 Mb|
|Price:||Free* [*Free Regsitration Required]|
Multiple postcondition can be listed together or in seperate statements. To document global entities functions, typedefs, enum, macros etc.
Doxygen cheatsheet ·
Post was not sent – check your email addresses! Part 2 is now out! Main menu Skip to content.
I want documents for file main. Groups Entities may be grouped into global modules, which appear together on a new page. To find out more, including how to control cookies, see here: Some markup for appearance: A longer comment, which may stretch over several lines and may include other things like: Markup for global information: Doxygen is a free tool for documenting code.
To do so, you need to put a structural command inside the documentation block. Code may be documented in a number of styles, including the “JavaDoc” style:.
Glad I could help! Doxygen and Graphviz only god will judge me.
Commenting in the QT style. Before the opening marker, a separate comment block may be placed that contains name and other information. Doxygen shedt also in-line comments comments on the same line as the documented piece of codeboth brief and detailed kind; these blocks can only be used to document members and parameters!
Generally, tags can be used multiple times for the same entity e.
To document a global C function, typedefenum or preprocessor definition you must first document the file that contains it usually this will be a header file, because that file contains the information that is exported to other source files. The same holds for namespaces.
For instance, if you want to document the class Testput the following documentation block somewhere in the input that is read by doxygen: Hence why we want automation. Basic markup Documentation blocks usually precede the element they refer to. Entities may be grouped into global modules, which appear together on a new page. As a suggested rule, this should only be information the reader can safely ignore, and of marginal interest like credits, inspirations and reasoning behind code.
As a suggested rule, this should be information the reader must heed, such as gotchas, limitations etc. So I am doxygeb trouble documenting a class as private in a different location: Markup for general information: How do I remove single classes from documentation?
Doxygen allows you to put your documentation blocks practically anywhere the exception is inside the body of a function or inside a normal C style comment block. Multiple invariants can be mentioned in a single or separate paragraphs. Doxygen is very flexible when it comes to the form of how the documentation is written, the layout presented here is simply my preference. Leave a Reply Cancel reply Enter your comment here Documentation in other places Doxygen allows you to put your documentation blocks practically anywhere the exception is inside the body of a function or inside a normal C style comment block.
So for instance I have in public. Documentation blocks usually precede the element they refer to. Sorry, and thanks for visit!