![]() Note that you can place your comment at other places using some tags like \class, \union, \fn, \var. If you want to putting the documention after, you have to add a marker <. In general, the comments must be before the declaration or definition of a type, a function or a member. *! \brief Brief description.įor more details, the web site of Doxygen explains it. An other option is to use a special C style comment which does not span more than one line. This command ends at the end of a paragraph, so the detailed description follows after an empty line. ' Doxygen is a documentation system for C , IDL (Corba, Microsoft, and KDE-2 DCOP flavors) and C. Graphviz (optional) You shouldnât need to install Graphviz manually under Fedora, as Doxygen has a dependency on it. refer to the Fedora Docsand either install missing packages selectively or install a set of packages (like texlive-scheme-full). To make a brief description, you can use the command \brief. LaTeX sudo dnf install doxygen-latex This metapackage should contain everything you need. A detailed description is used to explain generously the existence of an item. ![]() For each item of code, there are two types of descriptions, which together form the documentation : a brief description and detailed description. So the blocks of documentation in the sources files are the C comment blocks. Run Doxygen Adds a doxygen target that runs doxygen to generate the html and optionally the LaTeX API documentation. It is important that developers follow the grammar rules.
0 Comments
Leave a Reply. |