c++ - 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"};

这会导致警告

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

如果我将结构缩减为单个成员并从初始化程序中删除“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 中的警告消失。