2013-06-07 5 views
10

文書化されていないメンバ関数に関するdoxygen警告を抑制する方法を探していますが、//! @cond//! @endcondを使用しないので、メンバ関数はクラス。以下のような何か:文書化されていないメンバ関数のdoxygen警告を抑制しますが、位置はそのままにします

class Foo 
{ 
public: 
    Foo(); 
    Foo(const Foo&); 
    Foo& operator=(const Foo&); 
}; 

これらのメンバ関数は、明白なことを行うとマニュアルが必要ですが、クラスがあることを知っているので、私はまだ(彼らはドキュメントで利用できるメンバ関数の一覧に表示しませんコピー可能/譲渡可能事項)。つまり、doxygenはこれらのそれぞれについて「文書化されていない」警告を出します。 //! @cond//! @endcondを使用すると、その方法はドキュメントから完全に消えます。私が望むのは、その方法が文書に残っていることですが、それ以上のコメントはありません。酸素が文書化されていないと不平を言ってもらいたいです。

doxygenにドキュメントがないことを知らせるために何らかの「ダミーのコメント」がありますが、ドキュメントのメソッドはそのまま残っているため、表示されていますか?

+0

あなたが探している構成変数['WARN_IF_UNDOCUMENTED'](http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_warn_if_undocumented)はありますか?これを 'NO'に設定すると、Doxygenはこれらの警告を出しません。また、['EXTRACT_ALL'](http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_extract_all)を' YES'に設定する必要があります。 – Chris

+1

それは私が後にしていることではありません。私はいくつかの方法で警告を抑制したいが、他の文書化されていない方法についても警告を残す。本質的には、私が望むものは '//! @ nowarn'と '//! @ endnowarn'です。そうすれば、私はたくさんの警告を出すことなく静かにビルドすることができましたが、文書化すべきだがそうではない方法には注意を払います。 –

答えて

7

角括弧を追加するだけです。これは私のために働きます:

//! \{ 
const int myVar3 = 3; 
const int myVar4 = 3; 
//! \} 

出力はまだありません。必要に応じて、このコミントを\nowarn\endnowarnにエイリアスすることができます。

+0

素晴らしい、ありがとう! –

+0

優秀!これは天才です。 –

関連する問題