본문 바로가기
개발/work

doxygen 환경 구성

by heidiee 2022. 2. 18.

환경: Ubuntu 16.04

1. Install Doxygen

- sudo apt-get install doxygen graphviz doxygen-gui

- sudo apt-get install graphviz

 

// Doxygen gui 실행

doxywizard

 

2. doxygen 파일 생성 및 결과물 확인

- doxygen 실행할 폴더로 이동

- doxygen -g

Default로 'Doxyfile'이 생성됨

Doxyfile 을 열어서 configuration수정 --> cmd option으로 설정 될 수 있나?

 

- 설정 필요한 항목

PROJECT_NAME

PROJECT_NUMBER

RECURSIVE=YES // 하위항목까지 문서화

OUTPUT_DIRECTORY

GENERATE_TREEVIEW

GENERATE_LATEX

 

 

// latex directory는 무엇인가?

Graphviz는 링크 관계를 그래픽으로 출력해 주기 위해 설치하며 LaTex는 최종 PDF를 만들기 위해서입니다. 

 

 

 

 

 

// 참고 사이트

https://changun516.tistory.com/101

 

[Doxygen] Doxygen 설치 및 사용

| Doxygen 설치 및 사용 방법 0. Why Doxygen? * 개발 문서 자동화 * 주석 습관화 및 가독성 증가 * 소스코드와 맞는 문서 자동 업데이트 1. Doxygen 설치 * doxygen 패키지와 관계도를 표시할 graphviz를 ..

changun516.tistory.com

 

 

 

'개발 > work' 카테고리의 다른 글

systemd service Type  (0) 2022.04.18
Rule of 3, 5  (0) 2022.03.04
브라우저 제스쳐 동작용어: 핀치 인/아웃  (0) 2021.12.09
[Linux] core갯수 확인하기  (0) 2021.12.08
AUTOSAR: 자동차 임베디드 SW표준 아키텍쳐  (0) 2021.07.29