### 프로그래머 지원 블로그 ### http://iwoohaha.tistory.com 

프로그래머는 이렇게 산다
by 우하하 이글루스 피플



이글루 파인더
활용~!!
최근 등록된 덧글
옴니아는 터치가 구리죠...
by 450 at 11/04
우리집도 살때부터 찌릿..
by 삼성냉장고 at 11/02
찌릿찌릿 전기 통하는걸..
by 콘스탄티노 at 10/30
오즈옴니아 땡기는데.. ..
by 오좀니아 at 10/30
우리집도...찌릿하던데..
by 김혜은 at 10/30
T*OMNIA만 2이고, SH..
by 파미 at 10/29
아이폰나와여 되는데말..
by 450 at 10/29
카테고리
생활의흔적
프로그래밍
컴퓨팅환경
요즘읽는책
블로그활용
공개자료실
아갖고싶다
디카작품전
즐겨서찾기
해야할일들
해보고싶은
작성중인글(비공개)
우하하실록
가보고싶은
결혼이야기
웃어보자구
모바일생활
공연이야기
마이쭈니어
음악이야기
부자만들기
소프트웨어
개발기록지
최근 등록된 트랙백
chrome for mac
by 착각속의 (아가)고양이 ..
이통사가 스마트폰 수입..
by 아라의 글로벌 마인드 칼..
아이폰, 스마트폰 등이..
by 아라의 글로벌 마인드 칼..
국회의원의 점심식사는?
by 미래를 만드는 정치인 ..
태그
아이팟터치 5개국어 체크카드혜택 아이팟OS버그인가 새로운기능 깜빡이 제발부탁이다 두산동아 프로모션 컨버전스기기 iPodTouch 꺼짐은어떨까 보카 voca 단어학습 기억력테스트 KB체크카드 영한사전 정신좀차려라 앱스토어 한영사전 프라임 프로그래밍언어 방통위는 디폴트속성 네비바 M8200 iPhone 아이폰
이전블로그
2009년 11월
2009년 10월
2009년 09월
2009년 08월
more...
라이프로그
rss

skin by 봉팔
Doxygen으로 프로젝트 문서화하기
필요한 프로그램 다운로드 받기

1. Doxygen : 다운로드-윈도우용(doxygen-1.3.5-setup.exe)
                   참고사이트 : http://www.stack.nl/~dimitri/doxygen/

2. Graphviz : 다운로드-윈도우용(graphviz-1.10.exe)
                   참고사이트 : http://www.graphviz.org/

3. Doxbar : 다운로드-윈도우용 (doxbar-0.35-bin.zip)
                 참고사이트 : http://doxbar.sourceforge.net/

4. html help compiler (version 1.3) : 다운로드(htmlhelp.exe)

1. doxygen 설치하기

* 다운로드받은 doxygen-1.3.5-setup.exe 파일은 윈도우용 설치 프로그램 파일이다. 실행시킨 뒤 원하는 폴더에 설치한다.(디폴트값 : C:\Program Files\doxygen)

* doxygen이 설치된 경로 아래의 bin 디렉토리에서 다음과 같은 도스 명령을 실행시킨다.

doxygen -g [템플릿파일명]

위 도스 명령에서 템플릿파일명을 지정하지 않으면 Doxyfile이라는 이름의 파일이 생성된다.

* 생성된 템플릿 파일을 편집한다. 편집하기를 추천하는 부분은 다음과 같다.

OUTPUT_LANGUAGE = Korean

OUTPUT_LANGUAGE의 디폴트값은 English로 되어 있는데 Korean으로 변경하면 한글화된 문서를 얻을 수 있다.

EXTRACT_ALL = YES

생성 후 비어있는 문서항목들도 모두 표시한다.

EXTRACT_PRIVATE = YES

private 멤버들을 문서화할 것인지 여부.

EXTRACT_STATIC = YES

static 멤버들을 문서화할 것인지 여부

SOURCE_BROWSER = YES

소스에 대한 직접적인 정보링크를 만들것인지 여부

HAVE_DOT = YES

다음에 설명하게 될 클래스관계 그림 생성 여부(by graphviz)

2. graphviz 설치하기

이 프로그램은 클래스간의 관계를 알아보기 쉽게 그림으로 만들어내는 기능을 수행한다.

위에서 다운로드 받은 파일(graphviz-1.10.exe)은 윈도우용 설치 프로그램 파일이다. 그대로 실행시키면 디폴트값으로 "C:\Program Files\ATT\Graphviz" 경로에 설치가 된다.

3. Doxbar 설치하기

이 프로그램은 Visual Studio 6.0에서 Doxygen을 사용하기 쉽게 해주는 애드인 프로그램이다.

다운로드받은 파일(doxbar-0.35-bin.zip)의 압축을 풀면 다음과 같은 두 개의 파일을 볼 수 있다.

doxbar.chm, doxbar.dll

위 두 개의 파일을 적당한 디렉토리에 복사한다. 예를 들어 C:\Program Files\doxygen\Doxbar 디렉토리를 새로 만들어서 그 안에 집어넣는다.

4. Doxbar 설정하기

지금까지 doxygen, graphviz, doxbar를 모두 설치 완료하였다. 이제부터는 doxygen을 사용하여 프로젝트를 문서화하기 위한 설정 방법을 알아보도록 하겠다.

* Visual Studio 6.0을 실행시키고 Tools - Customize... 메뉴를 선택한다. 그리고 Add-ins and Macro Files 탭을 선택한 뒤 Browse 버튼을 눌러서 Doxbar.dll을 선택해주도록 한다.

그림 1.

Doxbar.dll을 등록시키면 위 그림에서와 같이 Doxbar.DSAddIn.1이 추가된다. 이 항목을 선택하고 Close 버튼을 누르면 다음과 같은 툴바가 Visual Studio에 추가된다.

그림 2.

* 다시 Visual Studio의 Tools - Customize 메뉴를 선택하고 Tools 탭을 선택한다.

그림 3.


위 그림에 나와있는 것과 같이 Doxygen이라는 항목을 추가하고 Command 항목값으로 C:\Temp\rundoxy.bat 을 등록한다.

여기에서 등록한 rundoxy.bat 파일을 실제로 존재하지 않는 입력값이다. 따라서 Close 버튼을 누르면 실제로 존재하지 않으므로 수정하겠느냐라는 메시지박스가 나타나는데 아니오로 선택하고 종료하면 된다.

* 그림 2.에서 보이는 Doxbar 툴바 버튼들 중에서 왼쪽에서 두 번째 위치한 버튼이 Doxygen에 대한 환경설정 기능을 수행한다.

환경설정을 수행하기에 앞서 Visual Studio의 Tools 메뉴를 선택하여 방금 전 추가한 Doxygen 툴의 번호가 몇인지를 확인하도록 한다.

그림 4.


위 그림에서는 10으로 표시되고 있다.

* Doxbar 툴바의 두 번째 버튼을 선택하면 다음과 같은 환경설정 대화상자가 나타난다.

그림 5.

앞에서 추가한 Doxygen 툴 메뉴의 번호대로 UserTool<번호>를 입력한다.

그림 6.


위 그림에서는 Doxygen이 실행될 때 실시간으로 만들어지는 배치파일의 경로, doxygen.exe의 경로, 디폴트 템플릿 파일의 경로, 도움말 컴파일러의 경로 등을 설정하고 있는 모습을 보여주고 있다.

그림 7.

위 그림에서 보이고 있는 값들은 디폴트값이다. 그대로 사용하면 된다.

5. Doxygen 실행하기

이제 마지막으로 doxygen을 실행시켜서 프로젝트 문서화를 해볼 차례이다. Doxbar의 맨 왼쪽 버튼을 누르면 Output 윈도우에 주르륵 표시되면서 문서화가 이루어진다.
이 블로그를 구독하시려면 이 버튼을 눌러주세요 ===>


by 우하하 | 2004/02/04 20:22 | 프로그래밍 | 트랙백(19) | 핑백(1) | 덧글(33) | ▲ Top
트랙백 주소 : http://woohaha.egloos.com/tb/260149
☞ 내 이글루에 이 글과 관련된 글 쓰기 (트랙백 보내기) [도움말]
Tracked from 미친병아리가 삐약삐약 at 2004/02/28 20:12

제목 : VS .NET용 doxygen..
문서작업에 쥑이는 doxygen이 VS .NET용으로 누가 만들어놨군요.. 역쉬 쥑입니다.. 후후.. http://www.codeproject.com/macro/KingsTools.asp 이번건 예전의 VC++ 6용 에드인보다 설치도 무자게 쉽습니다.. 그리고 죄다 통합되어 있어서 이것만 설치하면 더 설치할게 없습니당.. 다운로드는 아래에서 받으세요.. http://www.codeproject.com/macro/KingsTools/KingsTools.zip http://www.codeproject.c......more

Tracked from 미친병아리가 삐약삐약 at 2004/03/05 03:14

제목 : VC++ 6.0과 함께 사용하는데 유용한 프로그램..
Visual C++ 6.0을 여전히 애용중이라면, 아래와 같은 프로그램들을 같이 사용하면 정말 좋다.. 개중엔 공짜도 있고, 돈주고 사야하는 것도 있고, 아주 비싼 것도 있고, 말 안해도 당연히 대부분의 사람들이 사용중인 것도 있다.. WndTabs(http://www.wndtabs.com) 뉴스그룹에서 조동호님을 통해 알게된 공개용 프로그램.. 소스까지 공개가 되어 있으니 심심하면 함 까보는 것도 좋을 것 같다.. VC++ 6.0의 에디터창에 울트라에디터처럼 탭을 붙여주는 에드인이다.. 단점으로는 래쇼날 로즈와 함께......more

Tracked from 주드의 이글루 at 2004/03/13 14:41

제목 : Doxygen 사용법
Doxygen으로 프로젝트 문서화하기...more

Tracked from It's dorigom.. at 2004/11/18 17:20

제목 : Doxygen사용법
훔 이렇게 간단하게 되는걸... Doxygen으로 프로젝트 문서화하기...more

Tracked from Theory at 2004/12/19 16:16

제목 : Doxygen
Wow~ Fantastic~!!! Let's Use Doxygen...more

Tracked from Theory at 2004/12/19 16:19

제목 : Les's Use Doxygen
Doxygen으로 프로젝트 문서화하기 Wow~ Fatastic...more

Tracked from 써니의 一生牛步行 at 2005/01/31 16:25

제목 : 문서 자동화
Doxygen으로 프로젝트 문서화하기...more

Tracked from 다물의 디지털 세상 at 2005/04/12 14:15

제목 : Doxygen으로 프로젝트 문서화하기
우하하님의 블로그에서 찾은 Doxygen 설치법 입니다. 지금 당장 시작은 할 수 없지만 바쁜일이 마무리 되면 사용해 보도록 해야 겠군요...^^...more

Tracked from kkamagui의 끝없.. at 2005/04/29 00:25

제목 : [팁] VC6.0에 Doxygen 붙이기
Doxygen으로 프로젝트 문서화하기 오오~~ 대단하다. @0@/~ 바로 연결될 수 가 있군. 넘 멋진거 같다. ㅋㅋ 우하하님 만쉐이~...more

Tracked from 항상 나이스한 청키 at 2005/05/11 01:37

제목 : 제목을 입력해 주세요
내용을 입력해 주세요...more

Tracked from Hackest&#39;.. at 2005/06/29 15:18

제목 : VS6.0에서 doxygen 풀코스 설치하기.
닷넷은 KingsTools라는 편리한 툴이 있기에 상관이 없습니다만, 6.0같은 경우는, 좀 설치가 애매몽롱합니다. 그래서 밑의 글을 링크합니다. Doxygen으로 프로젝트 문서화하기...more

Tracked from 흰종이의 하얀세상 at 2005/08/23 21:30

제목 : Doxygen 설치 및 사용법
Doxygen으로 프로젝트 문서화하기 ...more

Tracked from JK's Progra.. at 2006/04/19 18:00

제목 : Doxygen 사용
Doxygen으로 프로젝트 문서화하기 ...more

Tracked from 나른한 블로그 at 2006/06/12 17:20

제목 : 프로젝트 문서화하기
Doxygen으로 프로젝트 문서화하기...more

Tracked from 후천성 프로그래머 at 2006/09/29 15:21

제목 : Doxygen으로 프로젝트 문서화하기
Doxygen으로 프로젝트 문서화하기 ...more

Tracked from SyNoVa at 2006/10/25 01:47

제목 : Doxygen으로 프로젝트 문서화하기 (For Vi..
이 글은 http://woohaha.egloos.com/260149 에서 스크랩 해온 글입니다.퍼온이 코멘트 : Doxygen을 Visual Studio 6.0에서 설치하고 사용하는 메뉴얼 입니다. =====================================================================================필요한 프로그램 다운로드 받기1. Doxygen : 다운로드-윈도우용(......more

Tracked from Cry for Inno.. at 2007/01/05 17:43

제목 : Doxygen으로 프로젝트 문서화하기
Doxygen으로 프로젝트 문서화하기 굉장히 좋군요?...more

Tracked from danga80의 잡동사니 at 2007/02/05 19:25

제목 : Doxygen으로 프로젝트 문서화하기
Doxygen이 나온지도 꽤 되었다. 프로그램의 문서를 자동으로 만들어주는 유틸리티이다. 이걸로 문서를 만들어서 끝난다기보다, 이걸로 만들어낸 문서가 시작점이 되는 듯 하다. 한 번 쯤 봐 두면 좋을 듯 하다. 이런 것도 있구나 하고..0. 필요한 프로그램 다운로드 받기 1. Doxygen : 다운로드-윈도우용(doxygen-1.3.5-setup.exe) 2. Graphviz : 다운로드-윈도우용(graphviz-1.10.exe) 3. Doxb......more

Tracked from Flexible at 2008/07/25 15:33

제목 : Doxygen 설치및 설정
Doxygen으로 프로젝트 문서화하기 좋은 정보.. 클라이언트는 .Net을 사용하므로 KingTools 를 사용하는데.. 간혹 툴관련한 쏘쓰 관리를 위해서 Doxygen설치를 하면서.. 유용하게 잘 봤습니다....more

Linked at 흰종이의 하얀세상 : Doxy.. at 2007/11/07 12:19

... Doxygen으로 프로젝트 문서화하기 ... more

Commented by 狂風 at 2004/03/06 09:51
우쓰~~ 감사.. 정리한게 있었는데. 우하하님꺼해서 더 보태야 겠네요~~ 쿠히쿠히
Commented by 최상기 at 2004/04/23 19:00
C:Program FilesdoxygeninDoxyfile 이런 설정이 안되는데 어떻게 하면 되지요
Commented by 우하하 at 2004/04/23 23:28
# 최상기님 : 1. doxygen 설치하기 부분의 처음 부분을 다시 살펴보세요.
doxygen -g [템플릿파일명] 라는 명령어를 사용하셔야 합니다.
Commented by 최상기 at 2004/04/26 09:18
doxygen -g [템플릿파일명] 이것을 수정하라고 하셨는데,
[템플릿파일명]의 예를 들어주셨으면 합니다.
확자를 뭘로 해야 하는지?
Commented by 우하하 at 2004/04/26 09:54
# 최상기님 : [템플릿파일명] 은 옵션입니다. doxygen -g 까지만 입력하면 Doxyfile 이라는 디폴트이름으로 생성됩니다.
예를 들면 위와 같이 확장자를 붙이지 않아도 되고 아무 확장자나 붙여도 됩니다.
Commented by 최상기 at 2004/04/26 14:38
문서로 작성이 완료 되면 그것을 어떻게 보나요?
어떤 파일의 형태로 나오나요, Output 윈도우에 보여지는 것이
전부는 아닐 거라 생각하는데
Commented by 우하하 at 2004/04/26 23:48
# 최상기님...우선 답변을 드리자면...
프로젝트 폴더 아래에 html 이라는 폴더가 생성되는데, 거기에 index.html 파일이 메인 파일입니다.
혹시 해보시지도 않고 질문하시는건 아닌지...궁금합니다. doxygen에 대한 자료를 좀 더 찾아보셔도 쉽게 아실 수 있을 것 같은 질문이라는 느낌이...
Commented by 엉바 at 2004/05/28 08:45
우하하님 이글 너무 좋아서 퍼가고 싶은데 그래도 되나요?
Commented by 우하하 at 2004/05/29 04:31
# 엉바님...살살 퍼가세요...남겨둘건 남겨두시구...^^
Commented by 엉바 at 2004/05/30 14:24
웹페이지 자체를 가지고 갈려고합니다.
당연히 출처는 밝히겠습니다. ^^ 유용한정보 잘쓰겠습니다.
Commented by 김영민 at 2004/06/24 15:31
2000에서 열심히 doxygen을 사용했던 유저 입니다.
어찌 어찌 하여 xp로 운영체제로 바꾸면서,, doxygen을 사용할려 하는데.. vs에서 파일을 찾지 못한다는 에러문구가 나오고 있습니다. doxygen을 돌렸을때 나오는 디버그 창에서는 파일을 분명히 파싱했는데요,,, 파일을 찾지 못한다는 문구의 메세지 경고 창이 나오구요,, 그리고 index.chm파일도 안만들어 지구요,, 어떻게 하면 해결할수 있는 것인지 아시는 분께서는 답변을 좀...... 아~~ 난해 합니다.
Commented by 우하하 at 2004/06/24 15:45
# 김영민님 : doxygen을 제거하고 다시 설치해보세요. 제가 작성한 순서대로만 하면 안 될일은 없을 것 같은데요...저도 예전에 한번 실패한 경험이 있어서리, 순서 그대로 정리를 해 놓은거거든요...뭔가 설정이 꼬인게 아닐런지...
Commented by 병아리 at 2004/07/13 22:10
우하하님 좋은글 올려줘서 우선 감사합니다...^^*
윈도우즈에서는 잘 되는데 리눅스에서 (RedHat9.0)에서 어떻게 설정을 하고 인스톨을 하는지 잘 모르겠어요... Doxygen홈페이지가서 열심히 봤는데... 잘 안되네요(영어가 딸려서 ㅡㅡ;;) 혹시 리눅스에서 Doxygen을 설치하고 사용하는 문서나 아시는것이 있으면 자료 부탁 드립니다...
Commented by 써니 at 2005/05/25 21:02
htmlhelp.exe 가 설치가 안되는 데 어떻게 하지요?
파일이름, 디렉터리 이름 또는 볼륨 레이블이 틀립니다 하면서...
Commented by 박성민 at 2005/07/27 21:37
위에 시킨대로 깔고 맨 왼쪽 버튼을 누르니.. 아무런 반응을 않합니다. ^^ 소스를 오픈한 상태고...어케 해야 되죠
Commented by 송영옥 at 2005/07/29 02:31
우하하님...정말 정말..잘보았습니다...
Commented by secMan at 2005/08/10 11:58
우하하님 홈피 깔끔하네요^^ 자주 들릴께요.ㅎㅎㅎ
Commented by 빠르크 at 2005/08/16 14:54
질문이 있는데요.. 위와 같이 하니..
Could not write batch file C:Temp undoxy.bat. Check configuration!
이라는 메세직 경고가 뜨네요.. 해결 방법좀 가르쳐 주시면 감사하겠습니다 m(__)m
Commented by 우하하 at 2005/08/17 20:59
# 빠르크님 : 그건 해당 파일이 존재하지 않기 때문입니다. 그냥 무시하시고 넘어가셔도 괜찮습니다.
Commented by aalee at 2005/08/29 23:19
잘 따라했다고 생각했는데; chm파일을 실행시키면 헤더파일들의 소스코드만 나옵니다. 윽; 좀 가르쳐 주세요;;
Commented by 노상수 at 2005/11/08 15:33
Could not write batch file C:Temp undoxy.bat. Check configuration!
이라는 메세직 경고가 뜨네요.. 해결 방법좀 가르쳐 주시면 감사하겠습니다 m(__)m

=>우하하 at 2005-08-17 20:59
# 빠르크님 : 그건 해당 파일이 존재하지 않기 때문입니다. 그냥 무시하시고 넘어가셔도 괜찮습니다.

[=>] 그럼 해당 문서화 작업된 파일은 어느 폴더에 있게 되는것입니까??
그리고 문서화 되는 작업 진행바 같은건 안보이는겁니까?? ㅡㅡ 첨이라 잘 모릅니다 .
도와주세요~~~
Commented by 쿠르릉 at 2005/12/07 03:22
Could not write batch file C:Temp undoxy.bat. Check configuration!
이런 메시지가 뜨는데

그냥 무시하고 넘어가라니 무슨소리인지요..-_-;;

doxgen bar에서 제일왼쪽버튼을 누르면 위의 메시지가
메시지박스로 뜨게되는데 OK 버튼 하나만있습니다.

그후에 아무 반응도 없고여..

무시한다음에는 뭘하죠?
Commented by 쿠르릉 at 2005/12/07 03:31
해보니 Temp 폴더 만들어주면되고
한글경로가 포함되면 안되는군요..
좋은자료 감사합니다.^^
Commented by 처리 at 2006/01/12 12:34
could not write batch file c: emp undoxy.bat. check configuration이란 메시지 박스는 왜 뜨죠?
Commented by 처리 at 2006/01/12 12:36
죄송 위에 있는 질문이네요
Commented by nagata at 2006/01/18 20:48
안녕하세요..doxygen을 살펴보다가 궁금한 사항이 있어 님께 질문드립니다.
doxygen으로 문서를 작성하면 주석내용을 base로 문서가 작성되잖아요..
a brief description and detailed description 내용도 주석으로 처리하는데요..
class를 예를 들면 detailed descripton 내용을 작성한 멤버 함수들이 멤버함수 설명이라고 아래 나오는데,detailed descripton을 주석이 아닌 방법으로 넣을 수 있는 방법 있을까요?
예를 들면 다른 파일에 써 있는 내용을 detailed descripton처럼 넣을 수 있는 방법 같은거요
답변 부탁드립니다..
Commented by 질문이여 at 2006/01/25 20:57
doxygen으로 pdf파일 만들려고 하는데 잘 안되네요..
우선 MikTex를 설치해서 만들어보니.. 클래스 관계에 관한 그림 한개만 pdf파일로 생성되었습니다.
그래서 지금 hPACK을 설치해서 해 보려고 하고 있는데요..
pdf파일 만드는법 좀 알려주실수 있을까요????
Commented by 궁금이 at 2006/02/15 13:55
아래와 같은 메세지가 출력되면서 더이상 진행이 안됩니다. 부탁드립니다.

메세지:-----------------------------------------------------------------------------------------------
D:40 문서툴Test>"C:Program Filesdoxygenindoxygen.exe"
Searching for include files...
Searching for example files...
Searching for images...
Searching for dot files...
Searching for files to exclude
Searching for files to process...
Reading and parsing tag files
Could not create output directory D:/40 /latex

D:40 문서툴Test>cd C: empouts

D:40 문서툴Test>"C:Program FilesHTML Help Workshophhc.exe" index.hhp
Unable to open index.hhp.
Tool returned code: 0
Commented by 우하하 at 2006/02/27 23:56
한글이 아닌 폴더에 두고 해보세요.
Commented by 감사합니다. at 2006/05/01 16:06
private으로 선언된 멤버들을 어떻게 표시하나 찾으러 돌아다녔는데 덕분에 해결했습니다.

그리고 doxygen관련 문서를 만들어 보고해야 하는데 자료를 퍼가도 돼나요?
Commented by 김형구 at 2006/10/25 21:10
멋진 자료 감사합니다!

덕분에 Doxygen을 쉽게 이용할 수 있었습니다!

고맙습니다!! 환상적입니다!!
Commented by 돌까루 at 2007/10/02 11:09
좋은자료 감사합니다.
좀 퍼갈께요.. ^^
Commented by 이효준 at 2007/10/19 13:45
고맙습니다. 퍼갈께요.

:         :

:

비공개 덧글



◀ 이전 페이지 다음 페이지 ▶