Doxygen 명령어

메인 페이지 꾸미기

메인 페이지를 꾸미는 예이다.
소스 파일에 메인 페이지의 명령어를 적는 것은 깔끔하지 않기 때문에,
별도의 파일mainpage.dox라는 파일을 만들어 사용하는 것이 좋다.

mainpage:  메인 페이지의 제목

버전은 doxywizard의 Project 탭의 "Project version or id"의 버전이다.

section developer: 개발자의 제목 출력

"-" : 글머리 출력

section advenced: 추가정보  제목 출력

"#" : 번호를 매길수 있다.

image html  : 이미지를 출력한다.

Doxygen을 빌드 할 때 이미지를 찾지 못하면 다음의 에러가 발생 할 수도 있다.

F:/work/doxygen/mainpage.dox:19: Warning: image file sunset.jpg is not found in IMAGE_PATH: assuming external image.

Doxyfile 설정 파일을 열어서 IMAGE_PATH에 이미지 디렉토리를 적는다.

IMAGE_PATH    =  F:/work/doxygen


class

해당하는 클래스 위에 주석을 달면 된다.주석은 "/**"로 시작한다.
아래에 해당하는 명령어들은 필요에 따라 생략해도 무방하다.

해당하는 클래스 위에 주석을 단다.
class: 클래스 이름을 단다.  (이 부분도 생략해도 무방)

brief: 간단한 개요을 나타낸다.

version: 버전 출력

author: 만든이

date: 날짜

remark: 설명을 적는다.

par:  brief나 remark 항목이외에 다른 항목을 사용하고 싶다면 par 명령을 사용한다.

 


함수

brief: 간단한 개요을 나타낸다.

remark: 설명을 적는다.

return: 리턴값을 적는다.

///< 멤버 변수나 함수 파라메터에 주석을 달때 사용된다.

 


그룹화

함수나 클래스를 파일단위가 아니라 기능별로 분류 할 수 있다.
변환된 문서의 확인 "Modules"에서 확인 가능하다.
그룹을 묶을 때는 addtogroup으로 시작해서 그룹의 종결 문 은 /** \} */로 끝낸다.

1. 그룹을 선언한다.
여기서는 taxi, bus 2개의 그룹을 정의 했다.
/**
    \defgroup taxi 택시 관련 클래스
    \defgroup bus 버스 관련 클래스
*/

2. 그룹을 묶는다.
 
/**
    \addtogroup taxi
    \{
*/

여기가 txai 그룹이다. !!!

/** \} */

 

 

 

 

펌 링크:

http://www.stack.nl/~dimitri/doxygen/manual.html

http://tong.nate.com/kimgua/34184853

http://blog.naver.com/koreteck/39156360