gpt4 book ai didi

doxygen - 禁止对未记录的成员函数发出 doxygen 警告,但保留概要

转载 作者:行者123 更新时间:2023-12-03 22:31:36 24 4
gpt4 key购买 nike

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

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

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

是否有某种“虚拟评论”告诉 doxygen 关闭缺少文档的信息,但仍然保留文档中的方法,因此它们是可见的?

最佳答案

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

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

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

关于doxygen - 禁止对未记录的成员函数发出 doxygen 警告,但保留概要,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/16993250/

24 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com