- #DOXYGEN SPECIAL COMMANDS HOW TO#
- #DOXYGEN SPECIAL COMMANDS UPDATE#
- #DOXYGEN SPECIAL COMMANDS MANUAL#
- #DOXYGEN SPECIAL COMMANDS CODE#
This is very useful to quickly find your way in large source distributions.
#DOXYGEN SPECIAL COMMANDS CODE#
You can configure doxygen to extract the code structure from undocumented source files. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages.
#DOXYGEN SPECIAL COMMANDS MANUAL#
It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in ) from a set of documented source files. Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL and to some extent D. */ In both cases the intermediate *'s are optional, so /*!. */ or you can use the Qt style and add an exclamation mark (!) after the opening of a C-style comment block, as shown in this example: /*! *. You can use the JavaDoc style, which consist of a C-style comment block starting with two *'s, like this: /** *. There are several ways to mark a comment block as a detailed description: 1. For the HTML output brief descriptions are also used to provide tooltips at places where an item is referenced.
![doxygen special commands doxygen special commands](https://i.stack.imgur.com/0rlsI.png)
An "in body" description can also act as a detailed description or can describe a collection of implementation details. As the name suggest, a brief description is a short one-liner, whereas the detailed description provides longer, more detailed documentation. 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). 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. Comment blocks for C-like languages (C/C++/C#/Objective- C/PHP/Java) For 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 SPECIAL COMMANDS UPDATE#
latest release v1.8.2 - last page update Sat Table of Contents Special comment blocks Comment blocks for C-like languages (C/C++ /C#/Objective-C/PHP/Java) Putting documentation after members Examples Documentation at other places Comment blocks in Python Comment blocks in VHDL Comment blocks in Fortran Comment blocks in Tcl Anatomy of a comment block For Python, VHDL, Fortran, and Tcl code there are different commenting conventions, which can be found in sections Comment blocks in Python, Comment blocks in VHDL, Comment blocks in Fortran, and Comment blocks in Tcl respectively. The next section presents the various styles supported by doxygen. A special comment block is a C or C++ style comment block with some additional markings, so doxygen knows it is a piece of structured text that needs to end up in the generated documentation. Ways to structure the contents of a comment block such that the output looks good, as explained in section Anatomy of a comment block. This is further detailed in the next section.
#DOXYGEN SPECIAL COMMANDS HOW TO#
How to put comments in your code such that doxygen incorporates them in the documentation it generates. Doxygen Documenting the code This chapter covers two topics: 1.