我應該如何用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，你需要使用\類型定義。