Как Doxygen может исключить класс C ++?

Question

Я хочу исключить класс из документации в Doxygen. Обычно эти классы находятся в файлах с одинаковыми именами, но часто они включаются в определения других классов. Это в основном для классов, начинающихся с "_" или "Private".

Как я могу сказать Doxygen исключить класс C ++?

Заранее спасибо.

Answer 1

Вы можете использовать тег \cond . Перед определением класса добавить:

\cond HIDDEN_SYMBOLS

и после определения класса добавить:

\endcond

Если вы не определите HIDDEN_SYMBOLS в своем докси-файле, содержимое между тегами \cond и \endcond не будет документировано. Вы можете заменить HIDDEN_SYMBOLS на что угодно.

Answer 2

EXCLUDE_SYMBOLS может быть моим ответом.

Answer 3

Используя Doxygen GUI, вы можете найти несколько опций исключения в

"expert > input"

Вы можете найти особенно полезным:

• Исключить символы: исключает все, что содержит определенное регулярное выражение, например / word /
• Исключить шаблоны: исключает регулярное выражение определенного пути, например / folder / или / some / file.cs /