Doxygen과 LaTex로 프로그램 소스 문서화 및 PDF 만들기

2013.11.03 13:21 컴퓨터/유틸리티

Doxygen과 LaTex로 프로그램 소스 문서화 및 PDF 만들기

시스템 개발 업무를 하다 보면 프로그램만 만드는 것이 아닙니다. 고객 미팅에 A/S 처리, 요즘은 줄었지만, 예전에는 디자인도 했었죠. 그러나 무엇보다도 싫은 것은 문서 작업입니다. 문서 작업하다 보면 짜증이 나서 프로그램만 짰으면 좋겠다는 생각을 자주 하게 됩니다. 아마도 이런 생각 때문에 Doxygen이 만들었겠지요? Doxygen의 도움을 받을 때면 얼마나 감사한지요.

▲ 문서를 따로 만들 필요 없이 프로그램을 작성하면서 주석을 부지런히 달아 놓으면 Doxygen의 도움으로 훌륭한 문서가 됩니다.

▲ LaTex를 거치면 이렇게 멋지게 PDF 파일로 만들어지니 문서 전달에도 최고입니다.

▲ 인쇄해 놓고 보면 기가 막힙니다. 이렇게 멋진 문서를 직접 만들어 내려면….그냥 포기하겠습니다. 수많은 링크를 맞추어서 작성한다는 것은 생각만 해도 머리가 지끈 거립니다. 그러나 평소에 달아 놓아야 할 주석만 착실히 입력해 놓으면 프로그램 소스를 문서화하는 것은 일도 아니네요. 모두 Doxygen 덕분입니다.

Doxygen 설치 방법

자, Doxygen 자랑은 이만하고 PDF 파일까지 만들어 내려면 무엇을 어떻게 설치하고 사용해야 하는지 정리해 보겠습니다. 우선 순서를 보면 아래와 같이 3개의 프로그램을 내려 받아 설치합니다.

  1. Doxygen
  2. Graphviz
  3. LaTex

Graphviz는 링크 관계를 그래픽으로 출력해 주기 위해 설치하며 LaTex는 최종 PDF를 만들기 위해서입니다. 설치 방법은 마이크로소프트 윈도우를 기준으로 설명하겠습니다. 설치 위치는 기본 폴더를 선택했습니다.

우선 Doxygen은 아래 링크에서 내려 받으세요.

▲ 페이지 중간에 Doxygen을 내려 받을 수 있는 링크가 있습니다.

Graphviz 설치

Graphviz는 아래 링크에서 다운로드 받아 설치합니다.

LaTex 설치

LaTex는 아래 링크에서 구할 수 있습니다.

파일도 크지만, 설치할 때 시간이 많이 걸리며 설치 완료 과정에서 도스 창이 뜨면서 확인을 위해 기다리는데 엔터 키 몇 번 눌러 완료 하면 됩니다.

▲ LaTex의 실행 파일이 있는 폴더가 PATH에 추가되어야 하므로 로그아웃 했다가 다시 로그인 합니다.

Doxygen 파일 만들 때 유의 사항

여기서는 내용이 많아 질 것 같아서 Doxygen 사용 방법은 언급하지 않겠습니다. 대신에 PDF를 출력하기 위한 과정을 정리하겠습니다.

▲ 우선 이미지를 만들어 주는 Graphviz를 이용하기 위해서는 아래 항목을 꼭 선택하거나 입력하십시오.

  1. Wizard 탭>>Diagrams>>Diagrams to generate에서 "Use dot tool from the GraphViz package"를 선택합니다.
  2. Expert탭>>Dot 항목>>DOT_PATH에 Graphviz이 설치된 폴더에서 bin 까지 포함헤서 입력하여 줍니다. 저 같은 경우 C:/Program Files (x86)/Graphviz2.34/bin 입니다.

이번에는 LaTex를 가지고 PDF를 만들기 위한 주의 사항입니다. LaTex를 이용하여 pdf를 만들기 위해서는,

  1. Doxygen에서 LaTex를 생성하고
  2. 명령 프롬프트에서 LaTex 파일이 생성된 폴더로 이동한 후
  3. make pdf 를 실행해서 pdf를 생성합니다.

▲ LaTex 파일을 생성하려면 Wizard>>Output에서 LaTex를 체크해 줍니다. 생성 옵션에 "as intermediate format for hyperlinked PDF"를 선택하면 목차에서부터 링크를 생성해 줍니다. 객체나 변수로 바로 이동할 수 있는 링크를 만들어 주어서 PDF 사용이 더욱 편합니다.

LaTex 파일은 Doxygen 생성 파일 폴더와 나란히 생성된 LaTex 폴더에 저장됩니다. 아래 의 순서로 pdf파일을 생성합니다.

  1. LaTex 폴더 안에 있는 refman.tex 파일을 열어서 \usepackage{hfont} 행의 내용을 \usepackage{kotex} 로 바꿔 줍니다.
  2. 명령 프롬프트에서 make pdf를 실행합니다.

만일 make pdf를 실행했는데 파일 생성은 되지 않고 에러가 출력된다면 LaTex의 bin 폴더가 PATH에 등록되지 않아서 입니다. 로그오프했다가 다시 로그인을 합니다. 다시 로그인을 해도 실행이 안 된다면 윈도의 PATH의 내용을 확인하고 LaTex의 bin 폴더의 경로가 없다면 직접 추가합니다. 저 같은 경우 C:\usr\texlive\2013\bin\Win32 입니다. 등록하는 방법은 윈도우 탐색기>>내 컴퓨터 오른쪽 마우스 버튼 메뉴>>속성 메뉴>>고급 시스템 설정>>고급 탭>>환경 변수 버튼을 클릭한 후, path를 클릭한 후 LaTex bin 폴더를 추가합니다.

로그아웃 했다가 다시 로그인 합니다. 다시 명령 프롬프트에서 LaTex 파일이 있는 폴더로 이동한 후 make pdf를 실행합니다. 정상적으로 진행되었다면 결과물로 refman.pdf 파일이 생성됩니다. 이제 제출만 하면 끝!!

P.S.

LaTex를 발음 그대로 라텍스라고 썼는데 이런!! 무식의 소치였네요. ^^; 레이텍 또는 라텍이라고 발음해야 옳다고 합니다. 알려 주신 분께 감사 드립니다.

신고
이 댓글을 비밀 댓글로
    • 2013.11.03 14:05
    비밀댓글입니다
    • dmasi
    • 2013.11.03 15:20 신고
    오오... 자바독보다 더 좋아보임니다 ;ㅁ; 언제 해봐야겠네요
  1. 유익한 포스팅 잘보고갑니다~
    오늘도 힘내서 아자아자~ 파이팅~
    • 새콤달콤
    • 2013.11.04 14:55 신고
    LaTex 의 배포 버전을 KTUG 에서 배포하는 것 말고
    http://www.miktex.org 에서 배포하는 툴을 쓰면 가능할까요? MikTex 이 설치나 사용이 쉽긴한데요...
    • LaTex가 설치되어 있어서 MikTex를 제대로 테스트할 수 있을까 모르겠어요. ^^;;
      따로 설치해 보고 확인하는 대로 말씀 드릴께요.
  2. 좋은 정보 감사합니다.
    많은걸 배우고 갑니다.~!!
    수고하세요~!!!
    • 2016.01.21 12:38
    비밀댓글입니다
    • 문서가 한글과 엑셀로 따로 작성하셨기 때문에 페이지 추가 방법으로는 어려울 것으로 생각됩니다.
      대신에 PDF 파일을 합치는 것은 어떨까요? 아래 방법을 참고해 보세요. ^^
      http://jb-story.tistory.com/53

      또는 한글에서 엑셀 파일을 읽어 들인 후 복사해서 한글 문서에 붙여 넣고 PDF를 만드는 방법은 어떨까요?