Tôi nên phân loại typedef bằng Doxygen như thế nào?

Question

Tôi có cấu trúc typedef trong mã C++ của mình. Kể từ bây giờ, chúng được liệt kê là \var typedef. Có cách nào tốt hơn để làm điều này? Dưới đây là ví dụ về những gì tôi có:

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

Tôi biết tôi thậm chí không nên nói param. Có gì khác để sử dụng?

Answer 1

Theo số Doxygen documentation có lệnh \typedef. Lệnh này hoạt động giống như lệnh \var.

Answer 2

Nếu bạn đặt khối nhận xét ở trước typedef, bạn không cần sử dụng bất kỳ lệnh đặc biệt nào.

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

Nếu bạn muốn đặt nó sau typedef sử dụng như sau: Chỉ

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

khi khối comment phải tại một địa điểm khác so với typedef thực tế, bạn cần phải sử dụng \ typedef.