如何在结构之外记录结构数据成员
How to document struct data members outside of struct
当我用 Doxygen 记录函数时,我可以这样做:
/*!
* @brief does something
* @param a first parameter
*
* Longer description
*/
void foo(int a) { /* */ }
但是我有没有办法以这种方式记录结构成员:
/*!
* @brief a struct
* @??? a first struct member
* @??? b second struct member
*
* Longer description
*/
struct a
{
int a,
int b,
};
原因是,如果可能的话,我想避免使用内联注释来记录我的结构成员。
/*!
* @struct str_a
* @brief my a struct
* @details Longer description
*
* @var str_a::a
* @brief first struct member
* @details detailed first struct member
* @var str_a::b
* @brief brf second struct member
* @details detailed second struct member
*
*/
struct str_a
{
int a;
int b;
};
当我用 Doxygen 记录函数时,我可以这样做:
/*!
* @brief does something
* @param a first parameter
*
* Longer description
*/
void foo(int a) { /* */ }
但是我有没有办法以这种方式记录结构成员:
/*!
* @brief a struct
* @??? a first struct member
* @??? b second struct member
*
* Longer description
*/
struct a
{
int a,
int b,
};
原因是,如果可能的话,我想避免使用内联注释来记录我的结构成员。
/*!
* @struct str_a
* @brief my a struct
* @details Longer description
*
* @var str_a::a
* @brief first struct member
* @details detailed first struct member
* @var str_a::b
* @brief brf second struct member
* @details detailed second struct member
*
*/
struct str_a
{
int a;
int b;
};