#DOXYGEN DOCUMENTATION MANUAL#

Of course, file members (functions, variables, typedefs, defines) do not need an explicit structural command just putting a documentation block before or after them will work fine.įirst style: documentation block before the code Files can only be documented using the second option, since there is no way to put a documentation block before a file.

The advantage of the first option is that you do not have to repeat the name of the entity (function, member, variable, class, or namespace), as Doxygen will analyze the code and extract the relevant information.

#DOXYGEN DOCUMENTATION MANUAL#

See section Documentation at other places in the manual to learn more about structural commands. A structural command links a documentation block to a certain entity that can be documented (a function, member, variable, class, namespace or file). Place a special documentation block somewhere else (another file or another location in the same file) and put a 'structural command' in the documentation block.See section Special comment blocks in the manual to learn more about these blocks. For file, class and namespace members (variables) it is also allowed to place the documentation directly after the member.

Place a special 'documentation block' (a commented paragraph) before the declaration or definition of the function, member, class or namespace.

The Getting started (Step 3) section of the Doxygen manual mentions the basic ways of documenting the sources.įor members, classes and namespaces there are basically two options: General workflow to produce source code documentation with Doxygen. Visit the source documentation page for instructions on building the FreeCAD documentation, which is also hosted online on the FreeCAD API website.

This document gives a brief introduction to Doxygen, in particular how it is used in FreeCAD to document its sources. Visit the Doxygen website to learn more about the system, and consult the Doxygen Manual for the full information. Doxygen is a popular tool for generating documentation from annotated C++ sources it also supports other popular programming languages such as C#, PHP, Java, and Python.

Doxygen documentation