1
我有幾個在C程序中創建的僞寄存器結構,並使用結構和聯合來實現字段並將所有寄存器集中在一起。Doxygen不包括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?
位域由Doxygen支持。使用doxygen 1.8.4版,我沒有看到你的例子(和一個默認配置文件)的問題。你正在使用哪個版本的doxygen? – doxygen
@doxygen啊,我在1.8.3.1,猜我需要更新。 – Toby
@doxygen這實際上沒有任何區別。 ALL_REGS和REGn記錄在數據結構和位下,並且全部記錄爲union ref頁面上的數據字段(儘管不在數據字段頁面上),但bitnName字段在所有記錄中都有記錄。 – Toby