c++ - C++ 类运算符的 Doxygen 外联文档

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 运算符!”但没有像这样的帮助。

有关运算符(operator)的信息永远不会显示。有几次我尝试将唯一值放入运算符(operator) 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。