c++ - org - instalar doxygen

Documentación de funciones macro en C++ con Doxygen

Question

¿Cómo puedo documentar una función macro en C ++ utilizando Doxygen y referirme a ella en la documentación de mi código no malvado?

Más específicamente, tengo una clase regular llamada "Mensaje" definida en Message.H que los usuarios pueden heredar para definir sus propios mensajes. En otro archivo ("MessageHelpers.H") tengo una macro loca como esta:

//! Users must call this macro to register their messages...
/*! 
   ...lest they be forced to type all sorts of boring and 
   error-prone boiler plate code. 
   blah blah blah... More specific documentation and explanation...
*/
#define REGISTER_MESSAGE_TYPE(MSGTYPE) /
 do_some(MSGTYPE);                     /
 seriously();                          /
 crazy_stuff(MSGTYPE);                       

En la documentación de Mensaje, me encantaría que la frase "REGISTER_MESSAGE_TYPE" pudiera convertirse automáticamente en un enlace y apuntar a mi documentación para la macro. P.ej

//! A cool message class
/*! 
   Users can inherit from this class to create their own cool messages.
   Just be sure to call REGISTER_MESSAGE_TYPE after your class definition!
*/
class Message
{
  virtual void doSomeStuff();
};

es posible?

Answer 1

Consulte http://www.doxygen.nl/manual/index.html

La sección "Comandos especiales" enumera el comando /def , y la sección "Generación automática de enlaces" describe lo que desea vincular a la macro.

Utilice /def para documentar una macro separada de la documentación. Utilice #MACRO(params) para enlazar automáticamente a dicha definición de macro.