Doxygen 세부 설정 및 사용방법

1. [Wizard] → [Project]

• ' Step 1' : 프로젝트 루트 폴더 지정, 이 경로 내에 소스코드와 Doxygen 결과 문서가 있어야 함
• 'Project name' : 프로젝트 이름 지정
• 'Project  version or  id' : 프로젝트 버전이나 다른 프로젝트와 구별할 수 있는 식별 번호를 입력, 정해진 형식 X
• 'Source code directory' : 소스파일이 있는 디렉터리로 지정
  • (예) "E:\Bitbucket\KmOpticalSensor\MVisionModule\KmvAas\Src"
• 'Scan recursively' : 체크하면 'Source code directory'에서 지정한 경로를 하위 디렉터리까지 재귀적으로 확인하여 문서 작성
• 'Destination directory' : Doxygen 문서를 생성할 경로를 지정, 자동으로 'html' 경로를 생성하니 Doxygen을 위한 디렉터리만 지정
• 'Source code directory'와 'Destination directory'는 절대경로로 입력할 것

 

2. [Wizard] → [Mode]

• 'All Entities' : 체크하면 모든 개체를 문서작성을 위해 확인
• 'Include cross-referenced source code in the output' : 체크하면 각 함수마다 사용한 함수 코드로 바로 Jump할 수 있는 링크를 생성해줌
• 'Select programming language to optimize the results for' : 소스코드의 프로그래밍 언어를 선택

3. [Wizard] → [Output]

• 'with navigation panel' : 체크하면 Doxygen 결과 문서로 html이 생성되면서, 문서의 왼쪽에 탐색 트리가 생김
• 'With search function' : 체크하면 문서 내에서 클래tm, 파일, 변수 등을 검색이 가능함
• 'LaTex' : 수식, 그래프, 다이어그램 등을 그릴 때 유용한 문서 제작 도구, RTF/XML 파일로 제작할 시 체크, 체크하지 않으면 html 생성 불가...?

4. [Wizard] → [Diagrams]

• 'Use dot tool from the GraphViz package' : 소스코드 간의 관계를 GraphViz로 표현
• 'Dot graphs to generate' : 시각적으로 보고 싶은 관계를 체크

5. [Expert] → [Project]

• 'DOXYFILE_ENCODING' : 한글 사용 시 한글이 깨지는 것을 막기 위해 'UTF-8' 사용(또는 'EUC-KR' 또는 'Korean-en')
• 'OUTPUT_LANGUAGE' : 모국어 선택

 

6. [Expert] → [Project]

• 'ALWAYSE_DETAILED_SEC' : 항상 상세 정보를 표시, 'REPEAT_BRIEF'와 같이 체크하면 개략정보 없이도 상세정보 영역을 생성함
• 'INLINE_INGERITED_MEMB' : 상속된 모든 멤버들을 보여줌(생성자와 소멸자 제외)

7. [Expert] → [Project]

• 'JAVADOC_AUTOBRIEF' : QT스타일 대신 자바스타일의 주석을 BRIEF로 해석, C++코드의 경우 체크할 것, 체크하지 않으면 BRIEF가 멀티라인으로 나타나지 않음
• 'SEPARATE_MEMBER_PAGES' : 멤버들에 대한 문서를 클래스와 오퍼레이션들의 설명이 있는 페이지와 분리, 멤버가 많을경우 유용

8. [Expert] → [Build]

• 'EXTRACT_ALL' : 체크하면 소스코드의 모든 요소가 문서화의 대상이 됨
• 'EXTRACT_PRIVATE' : 체크하면 클래스 내의 모든 private멤버가 문서화 대상이 됨
• 'EXTRACT_STATIC' : 체크하면 클래스 내의 모든 static멤버가 문서화 대상이 됨
• 'EXTRACT_LOCAL_CLASSES' : 체크하면 헤더파일에 없는 클래스도 문서화 대상이 됨
• 'HIDE_UNDOC_MEMBERS' : 체크하면 주석이 없는 멤버는 문서화 대상에서 제외
• 'HIDE_UNDOC_CLASSES' : 체크하면 주석이 없는 클래스는 문서화 대상에서 제외
• 'HIDE_IN_BODY_DOCS' : 체크하면 함수의 안쪽에 있는 주석은 모두 문서화 대상에서 제외

9. [Expert] → [Build]

• 'SORT_MEMBER_DOCS' : 체크하면 멤버들을 알파벳 순으로 보여줌, 체크하지 않으면 선언된 순서대로 보여줌
• 'GENERATED_TODOLIST' : Doxygen으로 만들어진 문서에 '관련된 페이지' 탭이 추가되고 그 탭에서 'todo' 태그들만 모아서 볼 수 있음, 클래스 설명에 'todo' 태그를 사용하면 유용
• 'GENERATE_TESTLIST' : 'GENERATED_TODOLIST'와 마찬가지로, 'test' 태그들만 모아서 볼 수 있는 페이지(탭)가 추가됨
• 'GENERATE_BUGLIST' : 'GENERATE_TESTLIST'와 마찬가지로, 'bug' 태그들만 모아서 볼 수 있는 페이지(탭)가 추가됨

10. [Expert] → [Source Brower]

• 'SOURCE_BROWSER' : 체크하면 상호참조가 이루어져, 소스파일의 리스트를 생성함
• 'INLINE_SOURCES' : 체크하면 함수 설명에 함수 소스코드가 들어감, C++의 경우 cpp 파일도 문서화에 포함됨

11. [Expert] → [Dot]

• 'CLASS_DIAGRAMS' : 체크하면 클래스의 상속 구조를 다이어그램으로 그림
• 'HAVE_DOT' : 'GraphViz'를 통해 다이어그램을 그릴 예정이며, 'GraphViz'에서 dot을 이용하므로 체크
• 'UML_LOOK' : 체크하면 다이어그램을 UML 형식으로 그림

12. [Expert] → [Dot]

• 'INCLUDE_GRAPH' : 체크하면 클래스의 INCLUDE 종속성을 그래프로 보여줌
• 'GRAPHICAL_HIERARCHY' : 체크하면 그래프를 TEXT가 아닌 그래픽으로 보여줌
• 'DOT_IMAGE_FORMAT' : 그래프들은 모두 이미지 파일로 생성되는데, 이 파일의 형식을 선택, png나 gif 추천

 

 

 

사용법

1. 'Run doxygen' 클릭 시, 문서화 시작됨

2. 'Show HTML output'  클릭 시, Doxygen에 의해 만들어진 문서가 켜짐

3. [Settings] → [Use current settings at startup] 클릭 시, 설정해놓은 옵션들이 그대로 유지(종료 후 재시작하더라도)

4. [File] → [Save 혹은 Save as...] 를 통해 설정한 옵션들만 파일로 저장가능