The special documentation block starts like a C-style comment /* but has an additional asterisk, so /** the block ends with a matching */.
DOXYGEN DOCUMENTATION UPDATE
This keeps the declaration and documentation close to each other, so it's easy to update the latter one if the first one changes. Usually you'd want to document the code in the header file, just before the class declaration or function prototype. 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.
![doxygen documentation doxygen documentation](https://i.ytimg.com/vi/Yu5XuahK3k8/maxresdefault.jpg)
A structural command links a documentation block to a certain entity that can be documented (a function, member, variable, class, namespace or file).
![doxygen documentation doxygen documentation](https://dnaeon.github.io/images/jenkins-pkgng-doxygen-build-triggers.jpg)