如何使用Doxygen的“其他地方的文档”具有专门的模板类功能？

Question

我面临着 Doxygen 的一个非常不重​​要的问题。但由于我无法在互联网上找到答案，并且我很好奇，所以我来这里请您分享您的知识。

当我在处理一个类时，我曾经在文档的标准位置定义小部分，但我也习惯在头文件的底部定义大的文档部分，例如代码示例或逐字记录，而不是在头文件的顶部定义它们每堂课。 那些我需要使用 Doxygen 的“其他地方的文档”功能。

这是一个有效的例子：

/** This is my class description */
class MyClass
    {
    ...
};


/*! @class MyClass
@code
    ...some code example
@endcode */

这通常效果很好。

但今天我尝试对专门的模板类使用相同的方法，但无法使其位于文档中的正确位置。

这是一个不起作用的例子：

/** This is my class description */
template < class Tr, class... Args >
class MyClass<Tr(Args...)> : public MyBaseClass {
    ...
};


/*! @class MyClass<Tr(Args...)>
@code
    ...some code example
@endcode */

我搜索了文档、Doxyfile 和互联网，但我仍然无法判断我是否没有按照应该做的那样去做，或者这是否是一个“错误”或非常规情况。

谢谢您的启发。

---

编辑：我用一个最简单的模板类（没有专门化）做了一些更多的测试，但这也不起作用。

/** This is my class description */
template < class Tr >
class MyClass
{
    ...
};


/*! @class MyClass // @class MyClass< Tr > // @class template < Tr > MyClass
@code
    ...some code example
@endcode */

我尝试在类名之后或之前指定模板，带或不带“template”关键字，并仅使用类名，但它似乎不起作用。

---

编辑 2：它确实适用于简单的模板类。之前的编辑测试不起作用，因为我已将类定义到名称空间中，而没有在 Doxygen 注释中指定名称空间：@class namespace::MyClass

但它仍然不适用于专用模板类，并且我仍然无法重定向专门模板类的注释块。

Answer 1

我认为你不应该把模板参数放在那里。做类似的事情：

/** This is my class description */
template < class Tr, class... Args >
class MyClass<Tr(Args...)> : public MyBaseClass {
    ...
};

/*! @class MyClass
@code 
    ...some code example
@endcode */

我不确定它是否有效（这里没有安装 doxygen），但我认为它应该有效。