14

我正在寻找一种方法来抑制关于未记录成员函数的 doxygen 警告,但不使用//! @condand //! @endcond,因此成员函数仍然出现在类的概要中。类似于以下内容:

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

这些成员函数做的很明显,不需要文档,但我仍然希望它们出现在文档中可用的成员函数列表中(因为知道一个类是可复制/可分配的事情)。照原样,doxygen 会针对其中的每一个发出“未记录”的警告。如果我使用//! @condand //! @endcond,这些方法会从文档中完全消失。我希望这些方法在文档中保持可见,但没有任何进一步的评论,我希望氧气不要抱怨它们没有记录。

是否有某种“虚拟评论”告诉 doxygen 闭嘴关于缺少文档,但仍保留文档中的方法,以便它们可见?

4

1 回答 1

12

您只需要添加括号。这对我有用:

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

没有警告,它仍然出现在输出中。\nowarn如果您愿意,您可以将此命令别名\endnowarn

于 2015-04-07T11:48:56.987 回答