Есть ли способ оптимизировать doxygen для C++?

Для проекта 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++»?

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


person Johan    schedule 15.09.2010    source источник


Ответы (1)


Мне кажется, что 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 или любые другие подобные параметры).

person Dan Moulding    schedule 15.09.2010