4/11/2023 0 Comments Doxygen example![]() For more information about how Doxygen works, see the official Doxygen website. This repository is set up as an example that shows how Doxygen can be used. Doxygen's section and subsection directives should not be used for now. Doxygen Example Doxygen is a tool that parses source code, finds specially-formatted comments, and produces nice-looking documentation files out of them. The JAVADOCAUTOBRIEF should also be set to NO for this case. Note the blank line in the last example, which is required to separate the brief description from the block containing the detailed description. Use the \par directive to make subsections with an optional heading. Here are two examples: /// Brief description. Links to known classes (such as ExampleClass1), functions (such as example_func()), and files (such as example_doc.h) are made automatically. To switch to Doxygen, type Doxygen in the Ctrl Q search box, or go to Tools > Options > Text Editor > C/C > General, and choose your preferred documentation style: Once specified, you can generate the comment stub by typing the respective /// or / above a function, or by using the (Ctrl /) shortcut. Note that doxygen is really picky about placement and association of comments so you always have to check what was generated. You can find a great documentation with many examples of DOT graphs in the manual Drawing graphs with dot. GraphViz uses the DOT language to describe graphs, Below are examples of the language, with their resulting outputs. 6: details If you want to add any further detailed description of 7: what is in the file, then place it here (after the first. The DOT language allows for simple definition of graphs. 1: / file doxygenexample.cpp 2: author Lastname:Firstname:A00123456:cscxxxxx 3: version Revision 1.1 4: brief Illustrates doxygen-style comments for documenting a C 5: program file and the functions in that file. However, it can include diagrams and images generated by external tools. If you have put the file in a group then the file-level documentation acts as documentation for that module or group, otherwise it acts as documentation for the file. Doxygen on its own doesn’t implement graphical operations. ![]() Please use a regular editor to view example_doc.h and example_doc.cc in order to understand how this documentation was generated.Įvery file needs \file and \brief near the top, and usually a \defgroup or \ingroup. This module illustrates how to document your files with doxygen. in your project directory, for example as docs/doxygen-tags/opencv.tag. Illustrates how to group documentation between files.Įvery class should be documented (this is the brief line) More.īrief documentation of second example class in group. Doxygen is a tool to generate documentations like the OpenCV documentation you.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |