수정뇌의 위키: Doxygen: Source code documentation generator tool

수정뇌의 위키

Doxygen: Source code documentation generator tool

해야할것 › API › C프로그래밍 › CVSNT › Cygwin › Doxygen

1 설치

2 실행 및 기본설정

3 무조건 해보기

3.1 설정초기화
3.2 Wizard를 이용한 기본설정
3.3 Expert를 이용한 세부설정(한글설정)
3.4 작업경로 지정(Step3)
3.5 문서생성(Step4)
3.6 생성된 문서보기
3.7 다양한 이용방법

4 설정파일 세부항목

1 설치 #

다운로드: http://www.doxygen.org 에서 download 페이지 이용
설치: 설치파일 실행 (예:doxygen-1.5.4-setup.exe)
설치관련해서 어려울게 없습니다.

2 실행 및 기본설정 #

"시작"메뉴 → "모든프로그램" → "doxygen" → "Doxywizard"
doxygen을 위한 기본 설정파일 생성
- doxygen 이용방법
  -DOS창에서 아래와 같이 명령사용
```
c:\program files\doxygen\bin\doxygen -s -g configfilename
```
  -s옵션: 주석없이 설정파일 생성 ( 설정변수의 의미를 알고싶다면 이 옵션을 빼고 생성해보자. )
  -g옵션: 이옵션 바로뒤에 지정된 파일명으로 설정파일을 작성 (기본값)
  (참고: 'doxygen -g -s configfilename' 명령은 잘못된 경우로 파일명은 Doxyfile로 지정됨)
- doxywizard 이용방법 (이게 쉽죠 )
  -'파일'메뉴에서 'Reset'선택

3 무조건 해보기 #

VC++ 6.0 소스로 적용해서 해보기

3.1 설정초기화 #

'File'메뉴→'Reset'

3.2 Wizard를 이용한 기본설정 #

Project탭
- Project name: 문서제목이다. 프로그램명이나 프로젝트명을 입력
- Project version or id: v1.0 과 같이 문서버전이나 부제를 입력
- $/!\$ 프로젝트명과 버전정보는 한글을 지원하지 않는다.
- Source code directory: [Select]를 이용하여 소스파일의 폴더를 지정
- Scan recursively: 위에서 지정한 소스폴더의 하위폴더 파일 포함여부 (체크하자)
- Destination directory: [Select]를 이용하여 doxygen이 생성할 문서가 저장될 폴더를 지정
- $/!\$ 폴더경로는 아래에서 지정한 작업경로를 기준으로 상대경로를 지정할수도 있다.
Mode탭
- Documented entities only: doxygen을 위한 각종지정자가 포함된것만 출력문서에 포함하여 작성한다는 의미이다.
갖고있는 소스에 doxygen을 위해 어떤작업도 안했으니 이옵션만으로는 제목페이지만 있는 문서만 얻게 될것이다.
- All entities: doxygen의 모든 출력물을 작성하도록 지정한다.
doxygen을 위한 지정자가 없는 내용도 문서에 포함하므로 일단 이놈을 선택하자.
- Include cross-referenced source code in the output: 소스코드를 문서에 포함한다.
HTML문서라면 'File(파일들)'탭에 소스목록 및 코드를 보기위한 [Code(코드)]링크를 추가한다.
위 옵션에서 'All entities'을 선택하지 않고 'Documented entities Only'를 선택했다면 이거라도 선택하자.
'All entities'와 함께 체크되면 코드내에 관련문서와의 링크가 생긴다.
- Optimize for C++ output: 문서대상 소스가 VC++이므로 이놈을 선택하자.
Output탭
- 출력물의 형식을 지정
- HTML만 생성할 것이므로 HTML항목외의 출력물 체크를 없애자.
Diagrams탭
- 도면작성을 위한 Dot툴(GraphViz)을 위한 설정들이다.
- Use built-in class diagram generator: 기본설정이다.
- Use dot tool from the GraphViz package to generate: Dot툴이 있으면 선택한다.
없으니 선택하지 말자.
[OK]버튼으로 Wizard종료

3.3 Expert를 이용한 세부설정(한글설정) #

Expert설정은 설정파일 세부항목을 참조하라.
여기서는 한글표시를 위한 설정만 한다.
Project탭
- OUTPUT_LANGUAGE: Korean선택
- OUTPUT_LANGUAGE: Korean-en선택
- TAB_SIZE: VC++ 에디터에서 설정한 값으로 지정
Input탭
- INPUT_ENCODING: EUC-KR입력(소문자도 무관)
- EXCLUDE_PATTERNS: 소스입력시 제외할 것들을 패턴형태로 지정
가령 CVS를 사용한다면 수정중인 소스의 파일사본들이 있으므로 이를 제외할 필요가 있다.
입력창에 */CVS/*라고 입력한뒤 [+]버튼으로 추가

HTML탭
- HTML_HEADER: 아래 내용의 파일을 작성한뒤 지정한다.
파일명: euckr-header.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=EUC-KR">
<title>DVR Server - Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>

위와 같이 하는 이유는 VC++파일은 완성형한글코드(CP949)이고 Doxygen의 출력물은 유니코드(UTF-8)를 기본으로 한다. INPUT_ENCODING을 지정하면 한글이 제대로 변환된다고 하지만 실제로는 출력물 작성중 코드변환 에러가 발생하여 위와 같이 복잡하게 해결하게 되었다.
{{{OK]}}버튼으로 Expert종료

3.4 설정저장(Step2) #

[Save]버튼으로 설정내용을 저장하자.
Status: not saved 상태에서는 doxygen문서를 생성할수 없도록 되어 있다.
설정파일 저장위치는 Wizard에서 지정한 Destination directory에 저장하는 것이 편하다.
팁: 설정파일을 파일명.Doxyfile과 같은 형태로 저장하고 탐색기의 확장자 연결설정에서
Doxyfile확장자를 Doxywizard와 연결해두면 탐색기에서 설정파일을 더블클릭만으로도
Doxywizard로 실행할수가 있어 편하다.

3.5 작업경로 지정(Step3) #

Working directory: 작업중 사용할 임시파일들이 저장될 경로를 지정
[Select]버튼으로 아무데나 지정하자.
이경로는 후에 Doxygen설정파일을 로딩할 경우 해당 설정파일이 위치한 경로로 자동으로 바뀌므로 특별히 신경쓸 필요는 없다. 단, 입력소스폴더와 문서저장폴더를 상대경로로 입력했다면 작업경로가 기준이 되므로 정확히 지정하자.

3.6 문서생성(Step4) #

Step2와 Step3의 작업을 완료해야 [Start]버튼이 활성화 될것이다.
[Start]버튼으로 문서 생성

3.7 생성된 문서보기 #

HTML형태로 생성했으므로 문서저장 경로아래에 html이라는 하위폴더안에 문서가 생성된다.
html폴더안의 index.html을 웹브라우저로 읽는다.
클래스 정보들이 포함된 문서가 작성되었을 것이다.

3.8 다양한 이용방법 #

이것만으로도 대단하지만 좀더 문서다운 문서를 작성하고자 한다면 doxygen을 위한 지정자를 이용해야 할 것이다.

4 설정파일 세부항목 #

작성중

You have a deep appreciation of the arts and music.

VoteMacro
DeleteThisPage
AliasPageNames
도움말목록

last modified 2008-04-24 15:38:59
Processing time 0.3545 sec

Contents