Documenting callback typedefs in Doxygen
I have the following typedef:
typedef void( __cdecl *tCallback )( const char* Message );
How would I document that correctly using Doxygen?
I would like to to have the tCallback documented and the parameters expected documented.
A simple example:
/// typedef test
typedef test bool
produces correct output in doxygen
//typedef tCallback
typedef void( __cdecl *tCallback )( const char* Message );
produces:
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.
and
//typedef void( __cdecl *tCallback )
typedef void( __cdecl *tCallback )( const char* Message );
produces the same as the above.
Add the following to your Doxyfile:
PREDEFINED = __cdecl=
This will cause Doxygen to ignore this identifier for purposes of documentation.
链接地址: http://www.djcxy.com/p/50248.html上一篇: 如何生成一个64位COM代理