我应该如何使用 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 文档 有一个 \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 不同的位置时，您才需要使用 \typedef。