Как Doxygen исключает класс С++?

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

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

Спасибо заранее.

Ответы

Ответ 1

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

\cond HIDDEN_SYMBOLS

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

\endcond

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

Ответ 2

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

Ответ 3

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

"expert > input"

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

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