Doxygen list all functions code#

Doxygen list all functions code#

This technique won't work if the source code that I want to disable contains Doxygen comment blocks marked up with /* */. I don't like that because it interferes with one of my frequently used coding techniques where I quickly disable large parts of source code by surrounding the code with /* */.

The other comment block markup styles build on the C-style multi-line comment /* */. / previous empty line begins a new block Several consecutive lines that all start with '///' together form a comment block: There are several markup styles, but my personal favourite is to begin each line with 3 slashes ('///'). files), these are presented later in this document.ĭoxygen only processes comment blocks that are specially marked up.

Constructors, Desctructors, methods, operators, global functionsĭoxygen can generate documentation for additional entitities (e.g.

Pretty much all C++ language elements can be documented:

9.1 9.2 9.3 10 Doxyfile configurationĬ++ language elements that can be documented.

8.3 Variables, typedefs, enumerations, preprocessor macros, namespaces.

4.5 Special case 5 The most important commands.

4.4 Documentation separated from element.

4.3 Documentation at the place of definition instead of declaration.4.1 Documentation before the element (default).3.2 Visual separation of comment blocks.2 C++ language elements that can be documented.