Doxygen 문서화되지 않은 문자열 값

Question

Doxygen (1.8.10)은 값이 내 문자열에 포함되어 있지 않다고 불평하고 있습니다. 여기에 문제

#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"}; 

나는 하나의 멤버로 구조체를 줄이고, 그 다음 경고가 사라 이니셜 라이저에서 "secondVal"를 제거하면이 경고

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

결과를 보여줍니다 최소한의 예입니다, 하지만 분명히 해결책이 아닙니다. ...

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. 

BTW 하나 더 팁 :

여러 줄의 실체에 대한 ///< 주석을 사용하지 마십시오.

: 당신이 ///< 주석을 사용하려는 경우

/** 
* 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