우분투에 Doxygen 설치 방법

우분투에 Doxygen 설치 방법

Doxygen은 C++, C, Java, Python 등 다양한 프로그래밍 언어의 소스 코드 문서를 생성하는 도구입니다. 이 블로그 글에서는 우분투에 Doxygen을 설치하는 방법을 단계별로 설명하겠습니다.

패키지 목록 업데이트

우선, 시스템의 패키지 목록을 업데이트해야 합니다. 이를 위해 터미널을 열고 다음 명령어를 입력하세요:

sudo apt update

이 명령어는 우분투 패키지 저장소에서 최신 패키지 목록을 가져옵니다.

Doxygen 설치

패키지 목록이 업데이트되면, Doxygen을 설치할 수 있습니다. 터미널에서 다음 명령어를 입력하세요:

sudo apt install doxygen

설치 과정에서 추가 패키지를 설치할지 묻는 메시지가 나타나면 `Y`를 입력하고 Enter를 눌러 설치를 진행합니다.

Doxygen 설치 확인

Doxygen이 제대로 설치되었는지 확인하려면 터미널에서 다음 명령어를 입력하세요:

doxygen --version

이 명령어를 실행하면 설치된 Doxygen의 버전이 출력됩니다. 예를 들어, `1.8.17`과 같은 버전 번호가 표시될 것입니다.

Graphviz 설치 (선택 사항)

Doxygen은 소스 코드 구조를 시각적으로 표현하는 데 Graphviz를 사용할 수 있습니다. Graphviz를 설치하려면 다음 명령어를 입력하세요:

sudo apt install graphviz

이렇게 하면 Doxygen이 소스 코드의 클래스 다이어그램, 호출 그래프 등을 생성할 때 Graphviz를 사용할 수 있습니다.

Doxygen 설정 파일 생성

Doxygen을 사용하려면 먼저 설정 파일을 생성해야 합니다. 프로젝트 디렉토리로 이동한 후, 다음 명령어를 입력하여 기본 설정 파일을 생성합니다:

doxygen -g

이 명령어를 실행하면 `Doxyfile`이라는 기본 설정 파일이 생성됩니다.

Doxygen 설정 파일 편집

생성된 `Doxyfile`을 열어 필요에 따라 설정을 수정할 수 있습니다. 기본 텍스트 편집기를 사용하여 파일을 열려면 다음 명령어를 입력하세요:

vi Doxyfile

여기서 주로 수정할 항목은 `PROJECT_NAME`, `OUTPUT_DIRECTORY`, `INPUT`, `RECURSIVE` 등입니다. 예를 들어, 프로젝트 이름을 설정하려면 `PROJECT_NAME` 항목을 찾아 다음과 같이 수정합니다:

PROJECT_NAME = "My Project"

Doxygen 문서 생성

설정 파일을 수정한 후, 다음 명령어를 입력하여 문서를 생성할 수 있습니다:

doxygen Doxyfile

이 명령어를 실행하면 설정 파일에 지정된 옵션에 따라 문서가 생성됩니다. 기본적으로 생성된 문서는 `html` 및 `latex` 디렉토리에 저장됩니다.

문서 확인

생성된 문서를 확인하려면 `html` 디렉토리로 이동한 후, `index.html` 파일을 웹 브라우저로 열면 됩니다. 예를 들어, 다음 명령어를 사용할 수 있습니다:

xdg-open html/index.html