[Doxygen] Doxywizard(Doxygen GUI) 프로젝트 기본 설정 방법

Doxygen 사용을 위한 본문은 아래 링크를 참고하세요.

[Doxygen] 독시젠으로 코드 문서 만들기 총정리 (예제 포함)

[Doxygen] 독시젠으로 코드 문서 만들기 총정리 (예제 포함)

Doxywizard(Doxygen GUI) 기본 설정

독시젠 문서를 생성하기 위해 Doxywizard를 사용하는 것이 아주 쉬운 방법입니다. 그런데 막상 실행해보면 화면에 설정 항목이 너무 많은데요. 본 포스팅에서는 최소한 설정해야 하는 기본 항목을 설명하도록 하겠습니다.

Doxygen GUI 기본 화면

문서화 소스 경로 설정하기

문서화를 위한 소스코드와 각종 페이지, 리소스가 있는 경로(또는 파일)를 설정해야 합니다. 아래 그림에 표시한 Select... 버튼을 클릭하여 경로를 지정합니다. 참고로, 앞으로 설정할 입력(Input) 경로와 출력 경로(Destination directory)는 이 기본 주소의 상대 주소입니다.

기본 경로 설정하기

위치	항목	값
프로그램 상단	Specify the working directory...	문서화를 위한 원본 자료 경로

위 그림의 예시를 보면, Source code directory에 pages라고 설정되어 있습니다. 즉, Source code directory는 다음의 경로가 되는 것입니다.

C:\Users\Gg\Downloads\ExamDoxygen\doxygen\pages

문서화 소스 자료

주의

 

 

별거 아니지만, 이 설정 하나 잘못하면 경로가 잘못 지정되어 문서화 결과를 아무것도 없을 수 있습니다. 그리고 Doxywizard의 설정 파일을 저장하고 불러오면, 설정 파일의 경로로 변경됩니다. 문서화 결과가 아무것도 없다면 경로를 다시 확인하세요.

 

Wizard 탭의 Project 메뉴

Wizard 탭의 Project 메뉴

위치	항목	값
Wizard > Project	Project name	문서 좌상단 큰 제목
	Project synopsis	시놉시스(간단한 설명)
	Project version or id	버전 또는 아이디
	Project logo	이미지 파일 경로(가로 최대 200, 세로 최대 55 픽셀)
	Source code directory	문서화 소스 경로
	Destination directory	문서화 출력 경로

위 설정의 결과는 아래와 같습니다.

HTML 문서 생성 결과

Wizard 탭의 Mode 메뉴

Wizard 탭의 Mode 메뉴

위치	항목	값
Wizard > Mode	Select the desired extraction mode	All Entities: 모든 주석 문서화
		Include cross...: 문서화 되어있는 소스 코드의 링크 연결 설정
	Select programming language to optimize the results for	프로그래밍 언어에 최적화된 문서 생성(언어에 따라 선택)

소스 코드의 프로그래밍 언어에 따라 최적화 옵션을 선택합니다.

Wizard 탭의 Output 메뉴

Wizard 탭의 Output 메뉴

위치	항목	값
Wizard > Output	Select the output format(s) to generate	생성할 문서 형식을 선택합니다. CHM이나 HTML 생성을 원하면 HTML을 체크합니다.
	plain HTML	HTML 기본 형식으로 생성됩니다.
	with navigation panel	HTML 좌측에 목차 페이지(navigation panel)이 추가됩니다.
	prepare for compressed HTML (.chm)	CHM 파일 생성을 원할 경우 선택합니다.
	With search function	HTML 우측 상단의 검색(search) 기능을 원할 경우 체크합니다.

아래의 좌측 이미지는 with navigation panel을 선택한 결과이고, 우측 이미지는 With search function을 체크했을 때 결과입니다.

Navigation 및 Search function 결과

만약, CHM 파일 생성을 원한다면 아래 링크를 참고하세요.

[Doxygen] HTMLHelp로 chm파일 만들기(+ 목차 한글 깨짐 해결 방법)

[Doxygen] HTMLHelp로 chm파일 만들기(+ 목차 한글 깨짐 해결 방법)

Wizard 탭의 Diagrams 메뉴

Wizard 탭의 Diagrams 메뉴

위치	항목	값
Wizard > Diagrams	Diagrams to generate	다이어그램 생성 여부 및 방법을 선택합니다.
	Use built-in class diagram generator	Doxygen 기본 생성 옵션입니다.
	Use dot tool from the GraphViz package	GraphViz를 사용하여 다이어그램을 생성합니다.

다이어그램은 기본 생성 옵션을 선택해도 됩니다만, 조금 더 꾸미고 싶다면 GraphViz 옵션을 선택합니다. GraphViz를 사용하기 위한 자세한 방법은 아래 링크를 참고하세요.

[Doxygen] Graphviz 적용하여 클래스 다이어그램 표시하기

[Doxygen] Graphviz 적용하여 클래스 다이어그램 표시하기

Expert 탭의 Project 메뉴

Wizard 탭은 아주 기본적인 항목만 설정이 가능합니다. 더 자세한 설정은 Expert 탭에서 가능합니다.

Expert 탭의 Project 메뉴

위치	항목	값
Expert > Project	DOXYFILE_ENCODING	CP949
	OUTPUT_LANGUAGE	Korean(영문 매뉴얼을 원할 경우 English)

Expert 탭의 Build 메뉴

Expert 탭의 Build 메뉴

위치	항목	값
Expert > Build	EXTRACT_ALL	모든 항목 문서화

EXTRACT_ALL을 선택하면 문서의 모든 요소가 문서화됩니다. 이를 원치 않고 세부적으로 설정하고 싶다면, 좌측 하단의 설명을 보면서 체크하면 되겠습니다.

Expert 탭의 Input 메뉴

Expert 탭의 Input 메뉴

위치	항목	값
Expert > Input	INPUT	문서화를 위한 파일 또는 경로 설정
	INPUT_ENCODING	CP949
	RECURSIVE	하위 경로 탐색
	EXAMPLE_PATH	예제 코드를 추가할 경우, 예제 파일이 존재하는 경로 설정
	IMAGE_PATH	문서화 페이지에 그림을 추가할 경우, 그림 파일이 존재하는 경로 설정

아래 그림의 좌측 이미지는 예제 코드(example code)를 추가한 모습입니다. 우측 그림은 페이지에 이미지를 추가한 모습입니다. 이렇게 그림이 추가될 경우, 그림 파일은 IMAGE_PATH에 존재해야 합니다.

Example code와 Page에 Image가 추가된 모습

여기까지 따라 하셨다면, 아주 기본적인 형태의 문서화 결과를 얻을 수 있을 것입니다.