Doxygenを使用したC++でのマクロ関数のドキュメント化

Question

Doxygenを使用してC++でマクロ関数をドキュメント化し、私の非悪用コードのドキュメントを参照してください。

具体的には、Message.Hで定義された「Message」という名前の定期的なクラスがあります。このクラスはユーザーが継承してメッセージを定義することができます。別のファイル（「MessageHelpers.H」）で、私は狂った。このようなマクロがあります：フレーズ「REGISTER_MESSAGE_TYPE」は自動的にリンクしてポイントになることができれば、メッセージのドキュメントで

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

を、私はそれを愛するだろう、私のマクロのドキュメント。例えば。

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

これは可能ですか？

Answer 1

はhttp://www.stack.nl/~dimitri/doxygen/manual.html

section "Special Commands"リスト\def commandを参照してください、とsection "Automatic link generation"は、マクロにリンクしたいものについて説明します。

\defを使用して、ドキュメントとは別のマクロを文書化してください。 #MACRO(params)を使用して、前記マクロ定義に自動リンクします。