我应该如何使用Doxygen对typedef进行分类？

Question

我的C++代码中有typedef结构.截至目前,它们被列为\vartypedef.有一个更好的方法吗？以下是我的例子:

/*! \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

如果将注释块放在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不同的位置时,才需要使用\ typedef.

Answer 2

根据Doxygen文档,有一个\typedef命令.该命令的行为与命令相同\var.