Есть ли способ оптимизировать doxygen для C ++? - PullRequest
6 голосов
/ 15 сентября 2010

Для проекта Qt / C ++ мы будем использовать doxygen для генерации некоторой документации, поэтому я ищу «оптимальный» конфигурационный файл.

Одна вещь, о которой я думал, это то, что у вас есть что-то вроде

OPTIMIZE_OUTPUT_FOR_C  = NO
OPTIMIZE_OUTPUT_JAVA   = NO
OPTIMIZE_FOR_FORTRAN   = NO
OPTIMIZE_OUTPUT_VHDL   = NO

Но я не могу найти что-то подобное для C ++, и я не уверен, что мне нужно что-то подобное для C ++.

Есть ли опция типа "OPTIMIZE_OUTPUT_FOR_C ++"?

Спасибо, Йохан

1 Ответ

8 голосов
/ 15 сентября 2010

Мне кажется, что Doxygen по умолчанию оптимизирован для C ++. Из того, что я могу сказать, C ++ был первым языком, с которым был разработан Doxygen; он был поддержан еще в «Журнале изменений». Поддержка Java, с другой стороны, не была добавлена ​​до версии 1.2.5. Параметр OPTIMIZE_OUTPUT_FOR_C также не был добавлен до версии 1.2.5, что указывает на то, что до версии 1.2.5 Doxygen предполагалось использовать больше для C ++ и меньше для C.

Без включения каких-либо других опций OPTIMIZE_FOR_<X> в выводе Doxygen используется именование в стиле C ++. Например, он создаст заголовок группы с именем «Классы» для перечисления всех классов и структур. С другой стороны, если включен OPTIMIZE_OUTPUT_FOR_C, то название заголовка группы изменится на «Структуры данных» (это имеет смысл, поскольку в C нет «классов»).

Итак, если вы хотите оптимизировать вывод для C ++, я думаю, что ответом будет просто использование настроек оптимизации по умолчанию (т.е. не включайте OPTIMIZE_OUTPUT_FOR_C или любые другие подобные опции).

...