Doxygen 的 C++ 异常文档类运算符

Question

如果我的文件中有一个类，我无法更改，但我需要在 doxygen 中记录，最好的方法是什么？我知道最好在实际的 .h 或 .cpp 文件中进行记录，但在这个特定实例中，这是不可能的。

我已经弄清楚如何记录一些成员，但我无法以可靠的方式记录操作员。让我举个例子。这是一个示例类，其中一个成员引起了问题，而一个成员工作正常：

class Foo
{
public:
    int Bar();
    bool operator!() const;
};

在 doxygen 查看的其他一些文件中，我放置了以下内容：

/// @fn Foo::Bar
/// @brief Some info about the constructor
/// @return Some stuff about what bar returns

构造函数的文档有效，但这不起作用：

/// @fn Foo::operator!
/// @brief Some info about the operator
/// @return Some stuff about what the operator! returns

也没有：

/// @fn operator!
/// @memberof Foo
/// @brief Some info about the operator
/// @return Some stuff about what the operator! returns

我还尝试使用 % 和 转义各个部分。所以它看起来像“/// @fn %operator!”、“/// @fn operator%!”或“/// @fn 运算符！”但没有任何像这样的帮助。

有关运营商的信息永远不会显示。有几次我尝试将一个唯一值放入操作员 doxygen 注释中，并在 doxygen 输出中查找它，但结果是空的。我做错了什么？

Answer 1

如果您查看 doxygen 输出，应该会出现警告

/path/to/Documentation: warning: no matching class member found for
  Foo::operator!()
Possible candidates:
  bool Foo::operator!() const

，在这种情况下，请更改文档以

/// @fn Foo::operator!() const
/// @brief Some info about the operator
/// @return Some stuff about what the operator! returns

记下附加到 @fn 标识符的附加 () const 。