Sử dụng doxygen để ghi lại thành viên của cấu trúc c bên ngoài định nghĩa cấu trúc

Question

Tôi đang sử dụng doxygen để nhận xét mã C của mình. Tôi đang sử dụng API nước ngoài (nghĩa là không phải của riêng tôi) mà tài liệu khan hiếm vì vậy tôi dự định ghi lại một số API đó trong các tệp nguồn của riêng tôi. Tôi do có tệp tiêu đề cho API nước ngoài nhưng không thực tế để thêm nhận xét của riêng tôi vào tệp đó.

Ngoại Tiêu đề

struct foreignstruct 
{ 
    int a; 
    int b; 
}; 

Tiêu đề của tôi

/** My structure comments... 
struct mystruct 
{ 
    /** Describe field here... */ 
    int field; 
}; 

/** @struct foreignstruct 
* @brief This structure blah blah blah... 
* @??? a Member 'a' contains... 
* @??? b Member 'b' contains... 
*/ 

thẻ gì để tôi sử dụng ở vị trí của @??? để có được sản lượng doxygen đúng (nơi 'đúng' có nghĩa là sản lượng tạo ra cho mystruct và foreignstruct giống nhau)?

Answer 1

Có lẽ một ngày nào đó doxygen sẽ có một thẻ @field đặc biệt cho điều này, cho đến thời điểm đó, sau đây có thể được sử dụng:

/** @struct foreignstruct 
* @brief This structure blah blah blah... 
* @var foreignstruct::a 
* Member 'a' contains... 
* @var foreignstruct::b 
* Member 'b' contains... 
*/ 

Đó là một ký hiệu ngắn tay cho

/** @struct foreignstruct 
* @brief This structure blah blah blah... 
*/ 
/** @var foreignstruct::a 
* Member 'a' contains... 
*/ 
/** @var foreignstruct::b 
* Member 'b' contains... 
*/