Menu
I want to exclude a class from documentation in Doxygen. Usually these classes are in files named the same, but there are many times when they are included inside other class definitions. This is mainly for classes starting with "_" or "Private".
How can I tell Doxygen to exclude a C++ class?
Thanks in advance.
830
Simply put an exclude pattern like this in the configuration file: Doxygen automatically generates a link to the class MyClass somewhere in the running text. How do I prevent that at a certain place? Put a % in front of the class name. Like this: %MyClass. Doxygen will then remove the and keep the word unlinked.
Doxygen is unware of the STL classes, so it does not know that class A relates to class B in the following example To overcome this problem you could provide the definition of the vector class to doxygen (by including the file that defines it at the INPUT tag in the config file).
Click here for the corresponding HTML documentation that is generated by doxygen. Indicates that a comment block contains documentation for a group of classes, files or namespaces. This can be used to categorize classes, files or namespaces, and document those categories.
The Doxygen structural command to use is “@mainpage” as shown in the example above. This tag on one of our markdown files will tell the Doxygen parser that a given markdown file is the main page for the project. This is the page shown when you click index.html from the HTML folder generated by Doxygen. These are the normal pages.
You can use the \cond tag. Before the class definition, add:
\cond HIDDEN_SYMBOLS
and after the class definition add:
\endcond
Unless you define HIDDEN_SYMBOLS in your doxyfile, the contents between the \cond and \endcond tags will not be documented. You can replace HIDDEN_SYMBOLS with whatever you like.
149
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
