c++ - 带有 Doxygen (C++) 的模板类中的 typedef

Question

我的问题是关于如何使用 Doxygen 在模板类中注释 typedef。我将举一个例子来说明我的问题:

 namespace fundamental
  {
    /**
    * Basic function
    */
    template <typename T>
    class Base
    {
    public:
      T x; ///< x coordinate
      T y; ///< y coordinate
    };
    typedef Base<float> Coordinate; ///< Point coordinate class
  }

使用Doxygen 处理以上代码后，我可以得到一个HTML 页面来显示类Base 的定义。但是对于typedef类Coordinate，它不会和Base出现在同一个页面中。事实上，所有 typedef 类型都列在基本命名空间页面中，连同该命名空间中的所有类。我想知道是否可以在基本 HTML 页面中显示坐标类。通过这样做，Base 和 Coordinate 之间的联系将变得更加紧密。谢谢!

Answer 1

typedef 是 namespace 的一部分，因此您必须记录 namespace 以使其出现，即​​:

/// documentation for the namespace
namespace fundamental
{
   ...
   typedef Base<float> Coordinate; ///< Point coordinate class
}

或者你可以使用 @relates但这会将成员置于基类的相关函数下:

/// @relates Base
/// Point coordinate class
typedef Base<float> Coordinate;

您可以通过使用 doxygen -l 创建布局文件将此标题更改为例如 Related Members然后编辑两次出现的 related生成的元素 DoxygenLayout.xml如下:

<related title="Related Members"/>