본문으로 바로가기
homeimage
  1. Home
  2. 컴퓨터/유틸리티
  3. Doxygen Warning: Compound ..... is not documented.

Doxygen Warning: Compound ..... is not documented.

· 댓글개 · 바다야크

Doxygen으로 파일을 작업하다 보면 Warning 이 많이 발생하네요. 일단 문서는 만들어 지기 때문에 시간이 없어서 그냥 넘어 갔지만, 프로그래밍에서는 컴파일 에러보다 더 무서운 것인 warning이기 때문에 늘 마음에 걸렸습니다.

빠진 파일도 없는데 문서화되어 있지 않다니 무슨 말인가 싶었는데, 간단한 이유를 너무 어렵게 생각했네요. 아래의 코드에서처럼 Doxygen 주석이 없으면 경고를 발생하는 것이었습니다.

#define MMX_TRUE      1
#define MMX_FALSE     0

typedef struct wav_info_t_ wav_info_t;
struct wav_info_t_
{
   unsigned char     chunk_id[4];
   unsigned long     size;
   unsigned short    tag;
   unsigned short    channels;
   unsigned long     rate;
   unsigned long     avr_samples;
   unsigned short    align;
   unsigned short    data_bit;
};
그러나 이렇게 각 항목에 대해 충실히 Doxygen 주석을 달면 보기 싫은 Warning 이 사라집니다.
/// mmxLib에서 사용하는 TRUE 값
#define MMX_TRUE                                    1
/// mmxLib에서 사용하는 FALSE 값
#define MMX_FALSE                                   0

/// WAV 파일 정보 구조 사용을 위한 typedef
typedef struct wav_info_t_ wav_info_t;

struct wav_info_t_
/**
    @brief  WAV 파일 정보 구조
*/
{
   unsigned char     chunk_id[4];
   unsigned long     size;
   unsigned short    tag;
   unsigned short    channels;
   unsigned long     rate;
   unsigned long     avr_samples;
   unsigned short    align;
   unsigned short    data_bit;
};
어이쿠~  Warning 이 싫어서라도 열심히 주석을 달아야겠네요. ^^
SNS 공유하기
💬 댓글 개
최근글
이모티콘창 닫기
울음
안녕
감사해요
당황
피폐

이모티콘을 클릭하면 댓글창에 입력됩니다.