Документирование обратных вызовов typedefs в Doxygen - PullRequest
8 голосов
/ 28 января 2011

У меня есть следующий typedef:

typedef void( __cdecl *tCallback )( const char* Message );

Как мне правильно документировать это, используя Doxygen?

Я бы хотел документировать tCallback и задокументировать ожидаемые параметры.

Простой пример:

/// \typedef test
typedef test bool

дает правильный вывод в doxygen

//typedef tCallback
typedef void( __cdecl *tCallback )( const char* Message );

производит:

C:/test.cpp:2: warning: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon)
C:/test.cpp:1: warning: member with no name found.

и

//typedef void( __cdecl *tCallback )
typedef void( __cdecl *tCallback )( const char* Message );

производит то же, что и выше.

1 Ответ

4 голосов
/ 29 января 2011

Добавьте в свой Doxy-файл следующее:

PREDEFINED = __cdecl=

Это заставит Doxygen игнорировать этот идентификатор для целей документации.

...