2013-07-12 2 views
1

C 프로그램에서 생성 된 여러 개의 가짜 등록 구조가 있고 구조체와 공용체를 사용하여 필드를 구현하고 모든 레지스터를 수집합니다.Doxygen은 C 비트 필드 설명서를 포함하지 않습니다.

모든 구성원, 필드 등은 주석을 문서화하고 있지만 제작 된 설명서에는 비트 필드에 대한 설명서가 나와 있지 않습니다. 어떻게 문서를 출력에 포함시킬 수 있습니까?

/** 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 : 내 구현의

예 (이 표시되지 않는 bitNName 의견이다) 그냥 생각 어쩌면 이것은 구조체를 포함하는 비트 필드의 모든 명명되어 있기 때문에 비트 -이 충돌입니다 doxygen을 위해?

+0

비트 필드는 Doxygen을 지원하는에 해결할된다. doxygen 버전 1.8.4에서는 예제 (및 기본 설정 파일)에 문제가 발생하지 않았습니다. doxygen의 어떤 버전을 사용하고 있습니까? – doxygen

+0

@doxygen Ah, 1.8.3.1에 대한 Im, 업데이트해야 할 것 같네요. – Toby

+0

@doxygen 이것은 실제로 차이를 만들지 않았습니다. ALL_REGS 및 REGn은 데이터 구조 아래에 문서화되어 있으며 비트는 모두 유니온 참조 페이지 (데이터 필드 페이지는 아님)에서 데이터 필드로 문서화되지만 bitnName 필드는 전혀 문서화되지 않았습니다 ... – Toby

답변

0

이 문제는 doxygen이의 최신 버전 :