Documenter les Macro-Fonctions en C++ avec Doxygen

Comment puis-je document d'une macro fonction en C++ à l'aide de Doxygen, et reportez-vous à la documentation de mon non-Evil code?

Plus précisément, j'ai une certaine classe ordinaire appelée "Message", défini dans le Message.H que les utilisateurs peuvent hériter de définir leurs propres messages. Dans un autre fichier ("MessageHelpers.H") j'ai un fou macro comme ceci:

//! 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);                       

Dans la documentation pour le Message, je l'aimerais si la phrase "REGISTER_MESSAGE_TYPE" pourrait devenir automatiquement un lien et le point à ma documentation pour la macro. E. g.

//! 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();
};

Est-ce possible?

OriginalL'auteur rcv | 2010-12-27