Как исключить переменные из вывода Doxygen?

Question

Я пытаюсь получить некоторую документацию XML от Doxygen, которая включает функции-члены и ИСКЛЮЧАЕТ переменные-члены.

Возможно ли это сделать?Из документа я не смог найти много ...

Спасибо!

Answer 1

Вы можете ввести каждое имя переменной в опции EXCLUDE_SYMBOL. Сколько существует разных имен переменных? Если вы не создали похожий шаблон в каждом имени переменной, т. Е.

Автомобиль varCar, varScooter;

, а затем

EXCLUDE_SYMBOL = var *

в вашем конфигурационном файле. Просто убедитесь, что ни один метод или имя класса не будут соответствовать вашему шаблону. Хотя я не нашел элегантного решения этой проблемы.

Answer 2

Возможно, вы хотите документировать все, что находится в общедоступном интерфейсе ваших классов, и пропустить все детали реализации.Если это так, вы можете использовать EXTRACT_PRIVATE = NO.

Answer 3

Для Objective-C может быть полезно объявить ivars в заголовке (чтобы их можно было использовать непосредственно в категориях или подклассах).

Однако, чтобы Doxygen пропустил это, добавьте следующее:

EXCLUDE_SYMBOLS = SomeType \
AnotherType \   
_*

.,это зависит от использования современного стандарта именования иваров с символом подчеркивания.