我应该如何分类与Doxygen的typedef？ [英] How should I classify a typedef with Doxygen?

问题描述

我在我的C ++代码中有typedef结构。现在他们被列为 \var typedef。有没有更好的方法来做到这一点？下面是我有的例子：

I have typedef structs in my C++ code. As of right now they are listed as \var typedef. Is there a better way to do this? Below is example of what I have:

/*! \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 。还有什么要使用？

I know I shouldn't even be saying param. What else is there to use?

推荐答案

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

According to the Doxygen documentation there is a \typedef command. The command behaves the same as the \var command.

这篇关于我应该如何分类与Doxygen的typedef？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！