简体   繁体   English

Doxygen不包括C位字段文档

[英]Doxygen not including C bit-field documentation

I have several psuedo-register structures created in a C program and have used structs and unions to implement the fields and collect all of the registers together. 我在C程序中创建了几个伪寄存器结构,并使用结构和联合来实现字段并将所有寄存器收集在一起。

Every member, field, etc has documenting comments, but the produced documentation does not show the documentation for the bit-fields... How can I solve this so that their documentation is included in the output? 每个成员,字段等都有文档注释,但是生成的文档未显示位字段的文档...如何解决此问题,以便其文档包含在输出中?

Example of my implementation (it's the bitNName comments that don't show): 我的实现示例(未显示的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;

UPDATE: Just thought maybe this is because the bit-field containing structs are all named bit - is this a conflict for doxygen? 更新:只是以为这可能是因为包含结构的位字段都被命名为bit-这对强力有冲突吗?

在较新版本的doxygen中解决了此问题:)

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM