c++ - 如何用 doxygen 记录一个函数对象？

Question

我应该如何用 doxygen 记录一个函数对象(又名仿函数)？仅将其记录为常规类(class)感觉会产生误导。我发现将函数对象视为具有闭包的函数要比将其视为可调用类要好得多。

有没有办法记录符合我偏好的函数对象？

class Adder
{
public:
   Adder( size_t x ) :
      m_x(x)
   { }

   size_t operator () ( size_t y ) const
   {
      return m_x + y;
   }

private:
   const size_t m_x;
};

Answer 1

给它类文档，将单词 functor 放在第一句(最好是第一个单词)，如果意思很明显，则跳过 operator() 文档。

请注意:如果 operator() 被重载，其含义通常不明显。