2015-06-26 6 views
2

Я использую библиотеку, которая переопределять тип пустот (среди прочих):Doxygen: Как переопределить недействительным

#define XX_VOID void 

Так что, когда я бегу Doxygen на код, как

/** 
* @brief Function description 
*/ 
XX_VOID foo(XX_VOID) 
{ 
    /*...*/ 
} 

Я получаю предупреждение

file.c:10: warning: return type of member foo is not documented 

Как я могу сказать, что Doxygen XX_VOID является недействительным, так что нет возвращаемого значения?

+0

Я не хочу, чтобы добавить что-то вроде '@return none' ко всем функциям, используя этот тип. – user4780495

ответ

1

Вы можете попробовать с MACRO_EXPANSION тэгом:

MACRO_EXPANSION

Если MACRO_EXPANSION тег установлен в YES, Doxygen будет расширять все имена макросов в исходном коде. Если установлено значение NO, будет выполнена только условная компиляция. Расширение макроса можно осуществлять контролируемым образом, установив EXPAND_ONLY_PREDEF на YES.

Значение по умолчанию: NO.

Для этого тега требуется, чтобы тег ENABLE_PREPROCESSING был равен YES.

С MACRO_EXPANSION набор для YES результат после Doxygen предварительной обработки становится:

void foo(void) 
{ 
    /* ... */ 
} 
+0

Разве он не будет расширять макрос в списке параметров тоже? – unwind

+0

Спасибо, он работает. Я пробовал теги «PREDEFINED» и «ENABLE_PREPROCESSING», но я пропустил «MACRO_EXPANSION». – user4780495

+0

@unwind Ты прав. Исправлено в ответе. Спасибо! – manlio

Смежные вопросы