我在 C 程序中创建了几个伪寄存器结构,并使用结构和联合来实现字段并将所有寄存器收集在一起。
每个成员、字段等都有记录注释,但生成的文档没有显示位字段的文档......我该如何解决这个问题,以便他们的文档包含在输出中?
我的实现示例(未显示 bitNName 注释):
/** This shows in documentation. */
union REG1 {
int all; /**< This shows in documentation. */
struct REG1BITS {
int bit1Name:1; /**< This is not in documentation. */
int bit2Name:1; /**< This is not in documentation. */
} bit; /**< This shows in documentation. */
};
/** This shows in documentation. */
union REG3 {
int all; /**< This shows in documentation. */
struct REG3BITS {
int bit1Name:1; /**< This is not in documentation. */
int bit2Name:1; /**< This is not in documentation. */
} bit; /**< This shows in documentation. */
};
/** This shows in documentation. */
extern struct ALLREGS {
union REG1 reg1Name; /**< This shows in documentation. */
union REG1 reg2Name; /**< This shows in documentation. */
union REG3 reg3Namd; /**< This shows in documentation. */
} CollectedRegs;
更新:只是想这可能是因为包含结构的位字段都被命名为位 - 这是 doxygen 的冲突吗?