2012-02-19 36 views
0

私はDoxygenを使用してC++コードを文書化しています。以下のような属性/変数が(まったく)ないことを除いて、すべてがHTML形式で出力されます。変数はDoxygenを使用して文書化されていません

/** 
    * Flag to check whether the variable is once initialized or not 
    */ 
    bool initialized_; 

何が間違っている可能性がありますか?

EDIT

initialized_はクラスのメンバ変数です。

答えて

2

変数initialized_(グローバル変数か、クラスの一部かなど)についての情報はほとんどありませんが、doxygen documentation(以下を参照してください)他の場所で見出しドキュメント)C++クラスのメンバーをドキュメントに

と述べて、あなたはまた、クラス自体を文書化しなければなりません。名前空間についても同じことが言えます。グローバルなC関数、typedef、enumまたはpreprocessorの定義を文書化するには、最初にそれを含むファイルを文書化する必要があります(通常、ヘッダーファイルになります。そのファイルには他のソースファイルにエクスポートされる情報が含まれているためです)。

グローバルオブジェクト(関数、typedef、enum、マクロなど)を文書化するには、定義されているファイルを文書化する必要があります。言い換えれば、少なくとも、このファイルの

/*! \file */ 

または

/** @file */ 

ラインがなければなりません。

+0

この行は、ヘッダー(インターフェイス)または実装ファイルに含める必要がありますか。それはまだ印刷されません。 –

+0

ドキュメントはかなり明確です。変数がグローバルオブジェクトであれば、それが定義されているファイルは( '\ file'で)文書化する必要があります。変数がクラスのメンバーである場合は、そのクラス自体を定義する必要があります。 'initialised_'がクラスメンバーであるというように質問を更新したので、そのクラスを文書化しましたか? – Chris

+0

クラス宣言の直前で、 '@ brief'、' @ param'などを書いて文書化しますか?それがあなたが意味していたなら、私はすでにそれをしました。 –

関連する問題