How can Doxygen exclude a C++ class?

Question

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.

score 18 · Answer 1 · edited Dec 17 '22 at 12:42

18

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.

edited Dec 17 '22 at 12:42

Andreas Haferburg

5,189
3
37
63

answered Oct 25 '09 at 00:41

James McNellis

348,265
75
913
977

Is there a way to do it in the sources without `\cond` and `\endcond`? Maybe something like `\nodoc` or `\nodoxygen` on the class? I did not see a command in the Doxygen manual under [Special Commands](https://www.stack.nl/~dimitri/doxygen/manual/commands.html), but I may have missed it. – jww Dec 25 '17 at 01:09

score 12 · Answer 2 · edited Feb 14 '11 at 18:47

12

EXCLUDE_SYMBOLS may be my answer.

edited Feb 14 '11 at 18:47

Quinn Taylor

44,553
16
113
131

answered Oct 25 '09 at 06:26

Kristopher Ives

281
1
2
7

score 2 · Answer 3 · answered Feb 29 '16 at 23:28

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/

How can Doxygen exclude a C++ class?

3 Answers3

Linked