Использование комментариев Lint с Doxygen

Question

Для документации нам обычно приходится создавать дополнительный документ, описывающий, что мы делали, когда в коде были отключены любые сообщения lint. (e.g. /* lint --e228), Было бы намного проще использовать его с doxygen (поскольку мы создаем это так или иначе).

Хотя я не смог найти решение о том, как сделать doxygen используя эти комментарии. Кто-нибудь пробовал это? Есть ли решение, как использовать stric '/*lint' но в любом случае добавить его в doxygen?

Спасибо!

Answer 1

Это может быть достигнуто путем определения макроса для расширения в комментарий выражения lint, но при этом макрос раскрывается в другой комментарий при расширении с помощью doxygen,

Хитрость заключается в том, чтобы использовать -save Инструкция к ПК-линту^ТМ или FlexeLint^TM:

#ifndef LINT_CONTROL
#define LINT_CONTROL(X) /*lint -save X */ //lint X
#endif

int main () {
    int a; LINT_CONTROL(-e530)
    return a != a;
}

Тогда в вашем doxygen файл конфигурации, вы можете включить расширение определенных макросов препроцессора. В частности, мы можем изменить LINT_CONTROL расширяться в doxygenкомментарий вместо.

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
PREDEFINED             = "LINT_CONTROL(X)=//! lint control: X"

В качестве альтернативы, если у вас есть FlexeLint^TM, вы можете изменить скрытый источник, чтобы комментарий doxygen можно было использовать для запуска элемента управления lint. Техника описана на форуме Gimpel Software.

_{PC-lint и FlexeLint являются товарными знаками Gimpel Software.}