2011-10-17 17 views
13

たとえば、関数パラメータの "メンバーの後に"ドキュメントを使用すると、ヘッダーの@paramの代わりに//!<を各パラメーターの後に使用すると、セクションは、生成された出力ファイルに常に "Return"の後に置かれます。doxygen function parameter documentation(//!<vs @param)

「戻る」の前に「パラメータ」が配置されるように順序を定義することは可能ですか?

/** 
***************************************************************************************** 
* @brief  Test API 
* 
* @usage  This API can be called at any time 
* 
* @return  0 if successful; or 1 if failed 
****************************************************************************************/ 

int TestAPI(
    int argument1,  //!< first argument 
    int argument2  //!< second argument 
    ); 
+0

「会員の後」の文書は文書化されていますか? – To1ne

+0

+1、まさに私が探していたもので、//方向を示すこともできます!<!in最初の入力引数、私はInt TestAPIの後の戻り値をインライン化します(//成功した場合は0を返します.. –

答えて

15

私はDoxygenの1.7.5.1であなたのコードを試してみて、あなたのコードで、出力パラメータリストが戻るの説明の後に来ることを確認しました。

//!<スタイルは@param持つすべてのパラメータの再状態名に持つよりもはるかに進歩しているように、これは、恥である:

/** 
***************************************************************************************** 
* @brief  Test API 
* 
* @usage  This API can be called at any time 
* 
* @param  argument1 first argument 
* @param  argument2 second argument 
* 
* @return  0 if successful; or 1 if failed 
****************************************************************************************/ 

int TestAPI2(
    int argument1, 
    int argument2 
    ); 

私はそれかどうかを確認するために、Doxygen Bugzilla bug databaseで見ていました比較的最近のバグでした(古いインストールに戻すことができます)。

Doxygen Bug 316311:2005年9月に報告された「インラインコメントを使用した返品後のパラメータ文書」が見つかりませんでしたが、修正されていません。

悲しいことに、私はあなたの質問の答えを恐れています "返信"の前に "パラメータ"が配置されるように順序を定義することは可能ですか?

編集

私はちょうどそれを求めて、Doxygen Bug 316311にメモを追加したことが確認=ステータスに変更するほぼ確実です。

+1

)最も確かに受け入れられる – Michael

関連する問題