Doxygen文書化されていない文字列の値

Question

Doxygen（1.8.10）は、値の文字列が文書化されていないと訴えています。ここではこれは私が単一のメンバーに構造体を削減し、イニシャライザから「secondVal」を削除した場合は、警告が消え、警告

/tmp/example.cpp:10: warning: Member firstVal (variable) of class MyClass is not documented. 

につながる問題

#include <string> 

struct MyStruct ///< Docs for struct 
{ 
    std::string a; ///< Docs for a 
    std::string b; ///< Docs for b 
}; 

class MyClass ///< Docs for class 
{ 
    static struct MyStruct instance; ///< Docs for instance 
}; 

struct MyStruct MyClass::instance = {"firstVal", "secondVal"}; 

を実証し、最小限の例です。しかし明らかにそれは解決策ではありません...

Answer 1

structを削除するだけです。以下のように：

#include <string> 

struct MyStruct ///< Docs for struct 
{ 
    std::string a; ///< Docs for a 
    std::string b; ///< Docs for b 
}; 

class MyClass ///< Docs for class 
{ 
    static struct MyStruct instance; ///< Docs for instance 
}; 

MyStruct MyClass::instance = {"firstVal", "secondVal"}; 

C++はstruct MyStructを使用する必要はありません、代わりにあなただけのプレーンなMyStructを使用することができます。この小さな変更を加えると、警告がdoxygen 1.8.13で消えます。

Answer 2

doxyfileのEXTRACT_ALLタグをYESに設定しようとすると、警告が消えるはずです。

はまたEXTRACT_ALL設定にコメントを注意してください。

# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 
# documentation are documented, even if no documentation was available. Private 
# class members and static file members will be hidden unless the 
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 
# Note: This will also disable the warnings about undocumented members that are 
# normally produced when WARNINGS is set to YES. 
# The default value is: NO. 

ところで一つのさらなるヒント：

複数行のエンティティの///<コメントは使用しないでください。あなたのコードをコメントする場合は、あなたのドキュメントの結果はこのように良くなります。

/** 
* Docs for struct 
*/ 
struct MyStruct 
{ 
    std::string a; ///< Docs for a 
    std::string b; ///< Docs for b 
}; 

/** 
* Docs for class 
*/ 
class MyClass 
{ 
    static struct MyStruct instance; ///< Docs for instance 
}; 

そうでない場合、あなたは///<コメントを使用したい場合、あなたは宣言のセミコロンの後にコメントを入れてあります。

struct MyStruct 
{ 
    std::string a; ///< Docs for a 
    std::string b; ///< Docs for b 
}; ///< Docs for struct 

class MyClass 
{ 
    static struct MyStruct instance; ///< Docs for instance 
}; ///< Docs for class