Doxygenを使用してMACRO C++に送信される関数を文書化

Question

最近、MACROSを使用してコンパイル時に推奨されなくなったコードにラベルを付けるコードが追加されました。 Doxygenは廃止された関数を正しく文書化していません。

#if defined(__GNUC__) 
    #define DEPRECATED(func) func __attribute__((deprecated)) /**< mark a function as deprecated in gcc. */ 

    #elif defined(_MSC_VER) 
    #define DEPRECATED(func) __declspec(deprecated) func /**< mark a function as deprecated in msvc. */ 
    #endif 

注これがこの記事のためのマクロの簡易版で、実際のマクロは、コンパイラのバージョンチェックになどを行う

その後マクロは、コンパイラは、関数があったことを知らせるための機能を中心に使用されていますコンパイラの警告が発行されるようになりました。

/** 
    * myMethod() is deprecated. 
    */ 
    DEPRECATED(
     /** 
     * @deprecated 
     * Description of deprecated function 
     * 
     * @param var this is a parameter 
     * 
     * @return this is returned 
     */ 
     int myMethod(int var) 
    ); 

問題はDoxygenのではないMyMethodは（int型VAR）非推奨のドキュメントを表示したいということです。

DoxygenでmyMethodを文書化する方法は知っていますが、マクロでは使用できません。

Answer 1

doxygenにDEPRECATEDマクロを削除する必要があることを伝える必要があります。あなたは、設定ファイルに以下のプリプロセッサオプションを使用してこの操作を行うことができます。

ENABLE_PREPROCESSING = YES 
MACRO_EXPANSION  = YES 
EXPAND_ONLY_PREDEF  = YES 
PREDEFINED    = "DEPRECATED(x)=x" 

あなたは-d Preprocessorオプションでdoxygenをを実行することにより、前処理の結果をデバッグすることができます。このオプションが存在すると、Doxygenは前処理が実行された後に入力ファイルを出力にダンプします。

詳細はhttp://www.doxygen.org/preprocessing.html

Answer 2

@fn tagを使用して、ブロックが何を参照しているかを明示します。暗黙的な接続ほど便利ではありませんが、より安全です。