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

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

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

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

Graphviz란?

Graphviz는 Graph Visualization Software의 약자로, 말 그대로 그래프를 시각화하는 오픈 소스 도구입니다. 아래 Graphviz 홈페이지의 Gallery 게시판을 보면 정말 다양한 종류의 그래프 시각화를 지원하고 있습니다.

http://www.graphviz.org/gallery/

Gallery

Graphviz Gallery 게시판 화면

사실 이렇게 보면 뭔가 투박하고 뭐 어떻게 사용해야 하나 고민스러운데요. 하지만 걱정하지 않아도 되는 것이, Doxygen에서는 Graphviz를 단순히 클래스 다이어그램을 생성하기 위해서만 사용됩니다. 게다가 Doxygen GUI의 프로젝트에서 몇 가지 설정만 하면, 사용자는 더 이상 신경 쓰지 않아도 되는 것이죠.

Graphviz 다운로드 및 설치하기

아래 Graphviz 다운로드 페이지에 접속한 후 자신의 OS 환경에 맞는 설치 파일을 다운로드합니다.

http://www.graphviz.org/download/

Download

저는 Windows 10 x64 환경이므로, graphviz-2.49.1 64bit를 다운로드했습니다.

Graphviz 다운로드 화면

설치 파일을 실행하면 아래와 같은 화면이 보입니다. 다음 버튼을 클릭합니다.

Graphviz 설치 파일 실행 화면

라이선스 동의 화면에서 동의함 버튼을 클릭한 후 다음 페이지로 넘어갑니다.

라이선스 동의 화면

설치 옵션으로 환경변수 선택 화면이 표시됩니다. 특별한 이유가 없다면 기본 값으로 두고 다음 버튼을 클릭합니다.

설치 옵션 화면

설치 경로 선택 화면에서도 특별한 이유가 없다면, 기본 경로 그대로 두고 다음 버튼을 클릭합니다.

설치 경로 선택 화면

마지막으로 시작 메뉴 폴더 선택 화면입니다. 기본 값으로 두고 설치 버튼을 클릭하여 설치를 진행합니다.

시작 메뉴 폴더 선택 화면

설치는 금방 끝나고 아래와 같은 화면이 표시되면 마침 버튼을 클릭하여 종료합니다.

설치 완료 화면

Doxygen GUI에서 Graphviz 설정하기

Doxygen GUI에서 다이어그램을 생성하는 방법은 두 가지가 있습니다. 기본 생성 방식과 GraphViz 방식인데요. 우선, 어떻게 표시되는지 결과부터 보겠습니다. 아래 그림 중 가장 왼쪽이 GUI에서 기본으로 생성되는 다이어그램입니다. 그리고 가운데가 GraphViz로 생성된 다이어그램입니다. 마지막으로 오른쪽은 UML_LOOK 옵션을 켰을 때의 모습입니다. 멤버 변수와 함수의 정보가 더 자세히 표시되는 옵션입니다.

그럼, Graphviz를 사용하기 위한 설정 방법을 알아보겠습니다.

Doxygen GUI를 실행하고 Diagrams 설정 화면에서, 아래와 같이 'Use dot tool from the GraphViz pacakge'를 선택합니다.

Doxygen GUI에서 GraphViz 사용을 위한 설정 화면

Expert탭의 Dot 메뉴에서 CLASS_DIAGRAMS를 체크합니다. UML_LOOK 옵션은 필요에 따라 체크합니다.

Expert 탭의 Dot 옵션 설정 화면

항목	설명
CLASS_DIAGRAMS	Class의 상속 관계를 다이어그램으로 표시하는 옵션.
UML_LOOK	Class의 상속 관계를 UML로 표시하는옵션. 사용하기 위해서는 HAVE_DOT이 체크되어 있어야 합니다.

마지막으로 스크롤을 조금 더 내리면 DOT_PATH 옵션이 있습니다. 폴더 선택 버튼을 클릭하여 Graphviz의 Bin 경로를 선택합니다. 기본 경로는 다음과 같습니다.

C:\Program Files\Graphviz\bin

Graphviz Bin 경로 선택

이 정도만 설정해도 처음 보여드린 클래스 다이어그램이 자동으로 생성됩니다. 만약, 폰트나 크기, 변수 개수, 함수 등의 세부적인 옵션을 지정하려면 Dot 탭의 메뉴에서 설정하면 적용됩니다.