Question

我正在寻找一种方法来抑制关于未记录的成员函数的doxygen警告，但是没有使用//! @cond和//! @endcond，因此成员函数仍然出现在类的概要中。如下所示：

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

这些成员函数显而易见并且不需要文档，但我仍然希望它们出现在文档中的可用成员函数列表中（因为知道类是可复制/可赋值的事务）。因此，doxygen会针对这些中的每一个发出“未记录”警告。如果我使用//! @cond和//! @endcond，则方法会从文档中完全消失。我想要的是方法在文档中保持可见，但没有任何进一步的评论，我希望氧气不要抱怨它们没有记录。

是否有某种“虚拟评论”告诉doxygen关闭缺乏doc，但仍保留文档中的方法，以便它们可见？

Answer 1

您只需添加括号即可。这对我有用：

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

没有警告，它仍然出现在输出中。如果您愿意，可以将此逗号别名设为\nowarn和\endnowarn。

禁止对未记录的成员函数执行doxygen警告，但将概要保留在原位

1 个答案: