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 이 싫어서라도 열심히 주석을 달아야겠네요. ^^
'컴퓨터 > 유틸리티' 카테고리의 다른 글
프로그램 아이콘 간단 변경 Awan Icon Changer (6) | 2009.07.11 |
---|---|
놀라운 TheWorld Browser (51) | 2009.06.29 |
네오{IP} 깜찍한 IP 변경 프로그램 (24) | 2009.06.10 |