gpt4 book ai didi

c - Doxygen 不包括 C 位域文档

转载 作者:太空宇宙 更新时间:2023-11-04 04:49:11 24 4
gpt4 key购买 nike

我在 C 程序中创建了几个伪寄存器结构,并使用结构和 union 来实现字段并将所有寄存器收集在一起。

每个成员、字段等都有文档注释,但生成的文档不显示位字段的文档...我该如何解决这个问题,以便它们的文档包含在输出中?

我的实现示例(未显示的是 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 冲突?

最佳答案

此问题已在较新版本的 doxygen 中得到修复 :)

关于c - Doxygen 不包括 C 位域文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/17619877/

24 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com