文書化されていない関数パラメータを表示

私はdoxygenを使ってC++コードのHTMLドキュメントを生成しています。残念なことにdoxygenは、メソッド記述の中で文書化されていないメソッドパラメータを表示しません。たとえば、次のように文書化されていない関数パラメータを表示

/** 
* Some method 
* @param p1 Some param 
*/ 
void method(const std::string& p1, const std::string& p2);

方法の説明がコメントやパラメータp1ではなくp2が表示されます。

明示的に文書化されていない場合でも、メソッド記述のすべてのパラメータをリストするようにdoxygenを設定するにはどうすればよいですか？

出典

2012-05-04 Marc-Christian Schulze

私の知る限り、これは可能ではない（私が間違っている可能性があります）。パラメータ 'p2'はdoxygenドキュメントのメソッドシグネチャに表示されますが、これは十分ではありませんか？パラメータのリストにも表示したい場合は、文書化する必要があります（ドキュメントを空白にしておくことができます。たとえば '\ param p2'のみを使用します）。 – Chris

すべてのパラメータがリストされていて、文書化されていないパラメータが空白のコメント（JavaDocのようなもの）を持っていると、もっと一貫しています。もちろん、すべてのパラメータを文書化すればこの問題は解決しますが、私は直接コメントを書くことができます。 ;） –

これはできません。

Doxygenは、不完全な、間違った、または不足しているパラメータのドキュメントについて警告することができます。

関連の設定は、次のとおりです。

WARNINGS   = YES 
WARN_IF_DOC_ERROR = YES 
WARN_NO_PARAMDOC = YES

出典

2012-05-05 13:05:07 doxygen

文書化されていない関数パラメータを表示

答えて

関連する問題