문서화

해당되는 글 3건

컴퓨터/유틸리티 2013.11.03. 13:21

Doxygen과 LaTex로 프로그램 소스 문서화 및 PDF 만들기

Doxygen과 LaTex로 프로그램 소스 문서화 및 PDF 만들기 시스템 개발 업무를 하다 보면 프로그램만 만드는 것이 아닙니다. 고객 미팅에 A/S 처리, 요즘은 줄었지만, 예전에는 디자인도 했었죠. 그러나 무엇보다도 싫은 것은 문서 작업입니다. 문서 작업하다 보면 짜증이 나서 프로그램만 짰으면 좋겠다는 생각을 자주 하게 됩니다. 아마도 이런 생각 때문에 Doxygen이 만들었겠지요? Doxygen의 도움을 받을 때면 얼마나 감사한지요. ▲ 문서를 따로 만들 필요 없이 프로그램을 작성하면서 주석을 부지런히 달아 놓으면 Doxygen의 도움으로 훌륭한 문서가 됩니다. ▲ LaTex를 거치면 이렇게 멋지게 PDF 파일로 만들어지니 문서 전달에도 최고입니다. ▲ 인쇄해 놓고 보면 기가 막힙니다. 이렇게 멋..

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

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 t..

컴퓨터/유틸리티 2009.04.21. 17:39

프로그램 소스로 문서를 만들어 주는 Doxygen

Doxygen을 사용한지 얼마 않되지 정말 좋네요. 문서 작업 하는 것을 좋아 하실 분이 과연 계실까요? 프로그램 작성도 힘든데, 일을 끝내도 만들어진 프로그램을 가지고 문서 작업을 하려면 한숨부터 나옵니다. 더욱이 프로그램을 수정할 때마다 문서도 함께 변경하려면, 정말 보통 일이 아니죠. 그래서 한참 열심히 Doxygen을 학습하고 있는데, 이 글에서는 지금까지 제가 알고 있는 지식을 정리하고, 더 자세한 내용은 Falinux Forum에 연제로 올리고 있습니다. 관심 있는 분은 참고 하세요. [Doxygen 1] 무엇에 쓰이는 물건인고? [Doxygen 2] 설치 및 간단 사용기 우선 설치부터 해야겠지요. Doxygen은 글로만 문서를 작성하지 않습니다. 함수의 관계를 보기 좋게 그래프로 작성하여 문..