How can Doxygen exclude a C++ class?

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 te开发者_开发知识库ll Doxygen to exclude a C++ class?

Thanks in advance.

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.

EXCLUDE_SYMBOLS may be my answer.

Using Doxygen GUI you can find multiple exclude options under

"expert > input"

You may find specially useful:

• Exclude symbols: Excludes everything containing a determined word regex like /word/
• Exclude patterns: Excludes a determinated path regex like /folder/ or /some/file.cs/