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

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

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

Спасибо!


person Pietro    schedule 29.11.2010    source источник


Ответы (3)


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

person cababunga    schedule 29.11.2010
comment
Боюсь, мне придется документировать все функции-члены (общедоступные, защищенные и частные, прокомментированные и нет) и исключить все переменные-члены... - person Pietro; 29.11.2010

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

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

а потом

EXCLUDE_SYMBOL = переменная*

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

person sMaN    schedule 16.12.2010

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

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

EXCLUDE_SYMBOLS = SomeType \
AnotherType \   
_*

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

person Jasper Blues    schedule 07.12.2013