소개

Doxygen을 사용하여 C# 프로젝트를 그림으로 하고 싶다고 부탁했으므로 사용법을 비망록.
Mac에서는 주로 명령 줄을 사용하지만 Doxyfile의 내용을 이해하고 싶었기 때문에,
이번에는 설치 프로그램에서 GUI를 사용합니다.

다운로드

Doxygen
h tps://그래서 r세훗r게. 네 t/p 로지ぇcts/두 xy 겐/후우 s/레 l-1.8.15/
잠시 업데이트되지 않았지만 현재 위에서 Doxygen-1.8.15.dmg를 설치했습니다.

Graphviz
dot 언어를 클래스 다이어그램으로 출력합니다. 다음 명령으로 다운로드.

$ brew install graphviz
$ dot -V
dot - graphviz version 2.40.1 (20161225.0304)

설정

Doxygen 설치 경로

/Applications/Doxygen.app/Contents/Resources

Graphviz 설치 경로

/usr/local/Cellar/graphviz/2.40.1/bin

上記を踏まえた上で 설정을 해 간다.

1. 시작Step1 의 부분에는 인스톨 한 Doxygen自身のパス 를 지정하지 않으면 안된다.
게다가 실행 파일이 아니라 実行ファイルのあるディレクトリ를 설정한다.
즉 Doxygen-1.8.15.dmg를 설치하면/Applications/Doxygen.app/Contents/Resources/doxygen에 실행 파일이 배치되지만, 처음에 기재한 Doxygenのインストールパス 를 지정.
주의점으로서, 패스의 설정은 우측의 Select... 버튼을 사용하지 않으면 반영되지 않는다.

2.Mode를 선택

3.Output 선택

4.Diagrams를 선택

5.Expert 탭 선택
OUTPUT_LANGUAGE을 한국어로 설정(선호)

6. 그대로 Expert 탭 상태에서 Topics를 스크롤DOT_PATH 에 최초로 기재한 Graphvizのインストールパス 를 설정.
다양한 설정이 완료되면 Next 버튼을 누릅니다.

7. 빨간 곳을 누르면 실행됩니다.Show HTML output 에서 출력된 HTML을 엽니다.
(지정된 출력 디렉토리의 index.html)Show configuration 에서 GUI로 설정한 Doxyfile 를 볼 수 있다.

기본 Doxyfile과의 차이

PROJECT_NAME           = "UserProject"
OUTPUT_DIRECTORY       = /Users/user/Documents/
OUTPUT_LANGUAGE        = Japanese
OPTIMIZE_OUTPUT_JAVA   = YES
EXTRACT_ALL            = YES
INPUT                  = /Users/user/work/Project/Scripts
RECURSIVE              = YES
GENERATE_LATEX         = NO
CLASS_DIAGRAMS         = NO
HAVE_DOT               = YES
CALL_GRAPH             = YES
CALLER_GRAPH           = YES
DOT_PATH               = /usr/local/Cellar/graphviz/2.40.1/bin

끝에

dmg로 인스톨 후 디폴트의 Doxyfile 는 이하의 커멘드로 생성할 수 있다.

$ /Applications/Doxygen.app/Contents/Resources/doxygen -g

생성처는 $HOME 가 된다.

GUI로 설정한 것은 Doxygen実行後 에 × 로 윈도우를 닫으려고 하면Doxyfileの保存先を選択 가능하기 때문에,
그 때 저장하면 설정한 Doxyfile 가 작성된다.
(역으로 그렇지 않으면 설정이 저장되지 않음)
저장된 Doxyfile를 열려면 Doxygen을 시작한 후,ファイル→開く 에서 Doxyfile 를 선택하지 않으면 로드되지 않습니다.

이상입니다.