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


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

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

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

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


4378
2018-06-07 21:28


起源

是配置变量 WARN_IF_UNDOCUMENTED 你在找什么?将此设置为 NO 并且Doxygen不会发出这些警告。您可能还需要设置 EXTRACT_ALL 至 YES。 - Chris
那不是我想要的。我想仅针对几种方法来抑制警告,但要保留其他未记录方法的警告。从本质上讲,我喜欢的是类似的东西 //! @nowarn 和 //! @endnowarn。这样,我可以在没有大量警告的情况下进行静默构建,但仍会收到应该记录但未记录的方法的警报。 - Michi Henning


答案:


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

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

没有警告,它仍然出现在输出中。您可以将此commants别名 \nowarn 和 \endnowarn 如果你喜欢。


9
2018-04-07 11:48



棒极了,谢谢! - Michi Henning
优秀!这是天才。 - Nathan Osman