Doxygen 最后一个枚举成员未记录
Doxygen last enum member not documented
我有一个枚举,它使用成员分组一次性设置一个组中的所有成员值。
这是代码:
/** MP format tags
*
* See the DC-007_E Specification.
* 5.2.2.3 Table 3, page 13
*/
typedef enum
{
/*MP Index IFD*/
///@{
///Mandatory
MPTag_MPFVersion = 0xB000,
MPTag_NumberOfImages = 0xB001,
MPTag_MPEntry = 0xB002,
///@}
///@{
///Optional
//TODO : implement those tags
MPTag_ImageUIDList = 0xB003,
MPTag_TotalFrames = 0xB004,
///@}
///@{
///Individual image tags (attributes)
MPTag_IndividualNum = 0xb101,
MPTag_PanOrientation = 0xb201,
MPTag_PanOverlapH = 0xb202,
MPTag_PanOverlapV = 0xb203,
MPTag_BaseViewpointNum = 0xb204,
MPTag_ConvergenceAngle = 0xb205,
MPTag_BaselineLength = 0xb206,
MPTag_VerticalDivergence= 0xb207,
MPTag_AxisDistanceX = 0xb208,
MPTag_AxisDistanceY = 0xb209,
MPTag_AxisDistanceZ = 0xb20a,
MPTag_YawAngle = 0xb20b,
MPTag_PitchAngle = 0xb20c,
MPTag_RollAngle = 0xb20d
///@}
}MPExt_MPTags;
但是枚举的最后一个成员 (MPTag_RollAngle
) 没有记录。
我将 DISTRIBUTE_GROUP_DOC
设置为 true
你可以看到html输出here
更新:
错误已修复:
您只需在最后一个 enum
元素后添加一个逗号即可自动记录它:
typedef enum {
// ...
MPTag_RollAngle = 0xb20d, // <<< add trailing comma
};
"adding a comma does work, but I don't think it is a final solution. Would it mean it is a Doxygen bug ?"
嗯,这当然可以被认为是 doxygen 解析器的错误。
但无论如何我个人更喜欢这种风格(老实说:我滥用它来使复制行和编辑更容易,在编写代码时应将其视为强烈反对的行为)。
我有一个枚举,它使用成员分组一次性设置一个组中的所有成员值。
这是代码:
/** MP format tags
*
* See the DC-007_E Specification.
* 5.2.2.3 Table 3, page 13
*/
typedef enum
{
/*MP Index IFD*/
///@{
///Mandatory
MPTag_MPFVersion = 0xB000,
MPTag_NumberOfImages = 0xB001,
MPTag_MPEntry = 0xB002,
///@}
///@{
///Optional
//TODO : implement those tags
MPTag_ImageUIDList = 0xB003,
MPTag_TotalFrames = 0xB004,
///@}
///@{
///Individual image tags (attributes)
MPTag_IndividualNum = 0xb101,
MPTag_PanOrientation = 0xb201,
MPTag_PanOverlapH = 0xb202,
MPTag_PanOverlapV = 0xb203,
MPTag_BaseViewpointNum = 0xb204,
MPTag_ConvergenceAngle = 0xb205,
MPTag_BaselineLength = 0xb206,
MPTag_VerticalDivergence= 0xb207,
MPTag_AxisDistanceX = 0xb208,
MPTag_AxisDistanceY = 0xb209,
MPTag_AxisDistanceZ = 0xb20a,
MPTag_YawAngle = 0xb20b,
MPTag_PitchAngle = 0xb20c,
MPTag_RollAngle = 0xb20d
///@}
}MPExt_MPTags;
但是枚举的最后一个成员 (MPTag_RollAngle
) 没有记录。
我将 DISTRIBUTE_GROUP_DOC
设置为 true
你可以看到html输出here
更新:
错误已修复:
您只需在最后一个 enum
元素后添加一个逗号即可自动记录它:
typedef enum {
// ...
MPTag_RollAngle = 0xb20d, // <<< add trailing comma
};
"adding a comma does work, but I don't think it is a final solution. Would it mean it is a Doxygen bug ?"
嗯,这当然可以被认为是 doxygen 解析器的错误。
但无论如何我个人更喜欢这种风格(老实说:我滥用它来使复制行和编辑更容易,在编写代码时应将其视为强烈反对的行为)。