我应该如何用Doxygen分类typedef？

Question

我在我的C++代码中有typedef结构。截至目前，它们被列为\var typedef。有一个更好的方法吗？下面是我的例子：

/*! \var typedef etc 
* \brief A type defined structure for etc 
* 
* \param x type- Variable declaration for x 
* \param y type- Variable declaration for y 
*/ 

我知道我甚至不应该说param。还有什么可用的？

Answer 1

根据Doxygen documentation有一个\typedef命令。该命令的行为与\var命令相同。

Answer 2

如果将注释块放在typedef的前面，则不需要使用任何特殊命令。

/** This is the documentation for the following typedef */ 
typedef MyClass MyTypedef; 

如果你喜欢把它之后typedef的使用：只有

typedef MyClass MyTypedef; 
/**< This is the documentation for the preceding typedef */ 

当注释块必须在不同的位置比实际的typedef，你需要使用\类型定义。