Doxygen tidak termasuk dokumentasi bidang bit C

Saya memiliki beberapa struktur register psuedo yang dibuat dalam program C dan telah menggunakan struct dan serikat pekerja untuk mengimplementasikan bidang dan mengumpulkan semua register bersama-sama.

Setiap anggota, bidang, dll memiliki komentar yang terdokumentasi, tetapi dokumentasi yang dihasilkan tidak menampilkan dokumentasi untuk bidang bit... Bagaimana saya bisa mengatasi ini sehingga dokumentasi mereka disertakan dalam keluaran?

Contoh implementasi saya (komentar bitNName yang tidak muncul):

/** 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;

PEMBARUAN: Saya pikir mungkin ini karena bidang bit yang berisi struct semuanya diberi nama bit - apakah ini konflik untuk doxygen?


person Toby    schedule 12.07.2013    source sumber
comment
Bitfield didukung oleh Doxygen. Dengan doxygen versi 1.8.4 saya tidak melihat masalah dengan contoh Anda (dan file konfigurasi default). Versi doxygen manakah yang Anda gunakan?   -  person doxygen    schedule 14.07.2013
comment
@doxygen Ah, saya menggunakan 1.8.3.1, sepertinya saya perlu memperbaruinya.   -  person Toby    schedule 15.07.2013
comment
@doxygen ini sebenarnya tidak ada bedanya. ALL_REGS dan REGn didokumentasikan dalam struktur data dan bit dan semuanya didokumentasikan sebagai bidang data pada halaman ref gabungan (meskipun tidak pada halaman bidang data) tetapi bidang bitnName tidak didokumentasikan sama sekali...   -  person Toby    schedule 15.07.2013


Jawaban (1)


Masalah ini telah diatasi di versi doxygen yang lebih baru :)

person Community    schedule 18.03.2015