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

2009.07.05 22:38 컴퓨터/유틸리티

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 이 싫어서라도 열심히 주석을 달아야겠네요. ^^
이 댓글을 비밀 댓글로
    • kjhnz
    • 2009.07.05 23:42
    jwmx 님께서 쓰시는 글은 대부분 좋아하는데 프로그램 관련해서는 딴나라 이야기 같습니다 ㅎㅎ

    앞으로도 좋은 프로그램 많이 소개 부탁드려요
      • 싸움꾼
      • 2009.07.06 00:27
      사실 저도 그런데, 그래도 한 번 읽어봅니다. 도움될까해서. ㅎ
    • 저도 헷갈렸던 부분이라 다른 분께 도움이 되지 않을까 해서 올렸습니다. :)
    • 나루터~
    • 2009.07.06 06:41
    잘몰라도 읽어 보고 나면 뭔가 남어야 하지만 이상스러울 만큼 프로그램 영역에 관한것은 멍해지내여
    하지만 수고 하시는분들이 계셔서 우리가 편안하게 사용하는 여러가지의 프로그램을 감사히 사용하니
    항상 감사한 마음으로 ㅎㅎㅎㅎ
    • kkjerry
    • 2009.07.06 08:16
    C 구문인가요?

    프로그래밍을 손뗀지 10년도 안된 것 같은데 이젠 정말 외계어처럼 느껴집니다...
    IT쪽을 떠난지는 이제 6년쯤 되어 가나 봅니다...
    자의반 타의반으로 떠났지만 이제는 추억으로만 남아있네요...

    가끔 서점에서 JAVA 관련 서적을 발견하거나
    뭔가 단순 반복적인 계산을 하려는데 엑셀은 잘 못해서 노가다를 해야 할 상황이 되면
    "프로그램 몇 줄 짜면 금방인데..." 하는 생각이라도 들라치면
    다시 그런 책들을 읽어볼까 하는 생각이 문득문득 들곤 합니다...

    월요일 아침 ..
    덕분에 커피와 함께 추억을 곁들여 한 주를 시작합니다...
    • 네, gcc입니다. 개발쪽에서 전혀 다른 분야로 이직하셨나봐요? ^^
      • kkjerry
      • 2009.07.07 08:21
      지금도 개발은 개발입니다만...

      도시개발입니다.. 생뚱맞죠? ^^

      원래 전공이 건설 분야인데
      선배의 꼬드김(?)에 IT분야에서 직장생활을 시작했더랬지요.

      쥔장님 덕분에 맘에 안들었던 익스플로러를
      이젠 편리하게 쓰고 있어 늘 감사한 마음입니다. ^^
    • 아하, 그러셨군요. ^^
      아울러 제 프로그램을 애용해 주셔서 감사합니다.
  1. 조카생겻네요 ㅋㅋ 간만에 뎃글다네요 *^^* 늘 감사합니다.
      • kkjerry
      • 2009.07.07 08:22
      이쁜 조카가 생기셨다니 추카드림미다 ^^
    • 하하, 축하드립니다. 얼마나 이쁠까요. ^^
    • LLOSloves
    • 2009.07.07 08:23
    아주 좋은 프로그램이네요
    그런데 오른쪽 상단에 있는 노무현 추모 이제 빼죠 계속 걸려있는데
    • 죄송합니다. 며칠 더 달아 놓겠습니다. 양해를 부탁드립니다
      • 쌀소년
      • 2009.07.07 09:12
      이분도 참 =_=;; 말투가
    • LLOSloves
    • 2009.07.07 09:18
    말투가 좀 거칠었다면 죄송합니다

    제가원래 노무현, 민주당, 진보신당 등 좌파세력을 좀 싫어해서요
    • 민주당은 저도 싫습니다. 그러나 노무현 전 대통령은 저의 마음 속의 대통령이라
      아직도 마음이 슬픕니다.
      그리고 노무현 전 대통령과 민주당을 함께 논하셨는데,
      아래의 글을 꼭좀 봐 주셨으면 합니다. ^^

      [url=http://mediatossi.com/1225]민주당은 '노무현'을 벌써 잊었나[/url]
      • 4천만
      • 2009.07.07 10:10
      진짜 좌파가 누군질 아세요?
      국군 통수권자인 국가 원수를 탄핵해서, 국가 기능을 마비시켜서, 적국을 이롭게하고,
      북한이 핵미사일을 발사하는 비상상황에 전투 비행장 코 앞에 일본분 초고층 빌딩짓게 하고,
      국가의 상징인 남대문을 경비업체 바꾸워 태워먹고
      중국 빨갱이 들이 올림픽때 서울시내에서 돌맹이 던져서 무고한 서울시민이 피흘려도
      국가 보안법 조항 전부를 탈법 하면서, 풀어주는게 좌파요 우파요?
      대체 어디서 좌파 운운이요?
      여기 많은 분들이야 말로
      나라 사랑하고 국민 걱정하는 우파중에 우파요.
      기르던 개가 죽어도 사람이라면 슬퍼하는 법인데
      대통령이 죽었거늘 어찌 인가죽을 뒤집어 쓰고 저리하는지.ㅉㅉㅉ
      • 비천무
      • 2009.07.07 10:44
      당신이 싫다구 빼라 마라할 입장은 아닌거 같은데요
      그럼 당신글 보기 싫으니 여기 오지말라하면 안올래요?
      초딩같은 생각하면서 어케 그나이 먹고 살아요?
      돌아가신분 추모하는게 뭐가 어때서 그딴 소리를 하시나요?
      도당체 생각이 있은거야 없는거야..
      나이를 뒤로 먹었나..
      • kkjerry
      • 2009.07.07 10:57
      LLOSloves님이 원래 말투가 그러시다니 이해해야겠지요...
      다만 개인별로 생각이 다르기에 노무현, 민주당, 진보신당 등이 맘에 안드시는 건 어쩔수 없다 해도 섣불리 "좌파세력"이라고 정의하시는 건 "불합리"하다 생각되는 군요...
      위에 4천만님께서도 그런 점에서 지적하고 싶으셨던 것이 아닐까 생각해봅니다...
      저처럼 여기 오는 많은 분들이 (그분의 잘잘못을 따지기 전에) 노무현 대통령의 죽음을 슬퍼하고 아직 그 마음을 추스리고 있는 상황인지라 님의 그런 섣부른 예단은 더 가슴아프군요...

      수구꼴통, 빨갱이, 좌빨,...
      이런 말들이 더 이상 의미없는 사회가 되면 얼마나 좋을까요...

      우리는 서로에게 너무 상처받고 상처를 주고 살아가는 것 같습니다...
      그러기에 LLOSloves님 같은 분의 한 두마디에 건드려진 상처는
      큰 고통이 되어 다시 상대방에 대한 맹렬한 공격으로 되살아나게 되는걸까요...

      그냥 허허 저런 사람도 있군.. 하면 좋을텐데
      우선 저부터도 울컥하고 화가 나는 자신을 발견합니다.

      하지만,
      우리는 안그랬으면 좋겠습니다.
      "상식이 통하는 사회"를 꿈꾸는 우리는, 그러지 않았으면 좋겠습니다.
      다른 이의 잘못도 너그러이 포용하는 우리가 되었으면 좋겠습니다.
      아마 노무현 대통령님도 생전에 겪은 수많은 고비를 생각컨대, 누구보다 많이 인내하고 포용하고 용서하시지 않았을까요?

      쥔장님 블로그에 온 손님인데 너무 글이 길었군요...
      너그러이 용서를... ^^;;
      • 4천만
      • 2009.07.07 11:38
      저를 비롯한 모든 국민들이 원하는게 좌파 우파 없이,
      힘든 사람 서로 돕고, 즐거울 때 함께 즐거워하고
      함께 사랑하며 사는 사회 입니다.

      진짜 좌파라고 욕먹을 것들은

      국민들 힘들던 말던, 나라 망하던 말던 말 같지 않은 명분을 내세우며
      국민들 니편 내편 갈라놓아, 싸움 붙히며
      니 혼자만 편하게 잘 살겠다는 분들 이십니다.

      한나라당에도 좋은 분들 계신 것 알죠.
      예를 들면 서울시장 오세훈씨도 숙청이 무서워 어쩔수 없이 따른다는 느낌도 살짝 들더군요...
      태클 있으시면 부탁드립니다.

      그리고 귀족 노조를 대체 어느 좌파들이 응원 합디까?
    • 울진이서포터
    • 2009.07.07 12:57
    그나저나..

    쥔장님께서 소개해준 'T-max window'가 오늘 open행사하는 걸로 아는데..

    혹시 참석하신 분 계신가요^^

    자체 Office, browser도 있다고 해서, 궁금해지네요~
      • 손님
      • 2009.07.07 13:48
      저두 소식이 급 궁금한 터인데 ㅎㅎ
      저와같이 기다리는 분들이 많으신가봐여~
      아무튼 좋은 결과가 나와줬으면 좋겠습니다.
      이런 않좋은 시국에도 좋은 소식으로...
      • 궁금이
      • 2009.07.07 14:04
      아 빨리 제대로된 스샷이라도 보고 싶은데 안올라오네요
      • kkjerry
      • 2009.07.07 14:25
      저도 무지 궁금해욥~~

      예전에 티맥스에서 나온 제우스였던가요?
      제 기억에 미들웨어 솔루션이었던 것 같은데...
      여하튼 무지 성능은 울트라캡숑이었던 걸로 기억합니다.

      전혀 다른 분야인 운영체제에서는
      어느 정도의 역량을 보여줄지...

      첫 술에 배부를리 없겠지만
      기대가 되는건 사실입니다. ^^;;
      • seafull
      • 2009.07.07 16:12
      저도 무척이나 궁금하네요.
      윈도우7에 맞서서 경쟁력이 있는지 아니면 희대의 사기극이 되는지 그래도 경쟁력이 있는 제품이었으면 좋겠네요.
      티맥스 기술로는 알아 주는 기업 아닌가 싶은데.
    • 방금전 포스팅했습니다. 놀러들 오세요
    • 알쏭달쏭
    • 2009.07.07 14:16
    http://twitter.com/projecty

    일단 반응은 부정적인게 많은듯;;
      • 알쏭달쏭
      • 2009.07.07 15:06
      ㄷㄷㄷ

      동영상 끊기고 멈추고 ㅎㅎ
      사이트 깨지고;;;

      스타 돌리기 시작하는데
      로딩만 몇분째인지;;; ㄷㄷㄷ
    • Shaun
    • 2009.07.07 17:12
    https://www.youtube.com/watch?v=gQYaq5RR2Iw
    티맥스 윈도우 시연 영상입니다...
    직접 갔던 사람들 말로는 강의만 1시간정도하고, 시연은 10분;;;
    거기다 틀어주는 동영상은 끊기네요... (플래이어는 티맥스 자체제작 플레이어... 거기서 끊기면... (응?))
    뭐 한 1~2년 다듬으면 좋은게 될것 같긴한데... 10월에 발매...(응?)
  2. 티맥스 윈도우 시연회 다녀왔습니다. 포스팅 마무리했는데 정리는 아직 *^^* 그럼이망
    http://webdes.tistory.com/ 놀러들와서 보세요