Настройте Doxygen, чтобы скрыть определенные имена или ключевые слова

Question

Я только начинаю с Doxygen, и провел немалые поиски по этому вопросу, так что простите, если есть очевидный ответ.

Я работаю над встроенным проектом, в котором функции могут быть помечены как debug или nodebug перед возвращаемым типом. В большинстве наших библиотек мы используем условный макрос, чтобы задать для libname_debug либо debug, либо nodebug в верхней части файла, а затем каждой функции предшествует libname_debug.

В целях документирования я бы хотел, чтобы Doxygen исключил libname_debug из документации по функциям. Он загромождает список функций и затрудняет просмотр типов возврата каждой функции.

Возможно ли пометить файл каким-либо образом, чтобы Doxygen пропустил этот символ? На данный момент я оборачиваю каждый экземпляр в @ cond / @ endcond:

/** @cond */ libname_debug /** @endcond */

Но это боль и добавляет дополнительную разметку к источнику.

Answer 1

Существует также страница doxygen , объясняющая, как справляться с такими ситуациями.Вы бы включили MACRO_EXPANSION (по умолчанию NO), сказали бы doxygen развернуть только некоторые макросы (EXPAND_ONLY_PREDEF) и добавили бы ваш символ как макрос с пустым расширением:

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
PREDEFINED             = libname_debug=

Answer 2

Вы можете определить макросы в файле конфигурации doxygen.Как то так

PREDEFINED += libname_debug