[Doxygen]

1.설치

http://www.stack.nl/~dimitri/doxygen/download.html 에서 Windows 버전을 설치한다.

Setup 버전과 Binary 버전이 있는데 Setup 버전을 설치한다.

Doxygen 은 Windows 환경에서 C:\ProgramData\Microsoft\Windows\Start Menu\Programs\doxygen 에 바로가기 파일이 저장이 되는데, 아이콘이 없다...TT.

아이콘은 간지의 상징이기 때문에 등록해야 한다.

Doxygen icone 다운로드

2. Doxygen 설정

보통은 github.io 와 Doxygen을 연동할 것이다. 그때 github.io 는 docs 폴더를 인식하므로
프로젝트 루트 폴더에 생성하고 html 폴더를 docs 로 바꿔주면 된다.

이 정도만 설명 하면 됬다. 다이어그램 같은건 필요하면 설치하고...(있어도 안볼꺼잖아?)

이런 설정들은 Save를 통해 Doxyfile 로 저장하고 쓰면 된다.

Doxyfile 이 있으면 cmd 에서 doxygen 명령어로 바로 추출이 가능하다.

나는 이 폴더를 Git Root 폴더에 넣고 아래 배치 파일을 만들어 사용한다.

if exist "docs" (
	rmdir /S /Q "docs"
)
doxygen
ren html docs
git add -A
git commit -m "ispring"
git push origin master

3.Doxygen 문법

@author 작성자 이름
@brief 설명. 여러 줄 가능
@details 문서에서 <more>을 누르면 나올 정보
@class 클래스 정의
@date 날짜
@exception 예외 처리 설명(C++에서 예외처리는 가급적이면 사용하지 않는다)
@file 파일 이름
@param 파라메터 설명
@remark 참고 설명
@return 반환 값 설명
@bug 존재하는 버그에 대한 설명
@see 참고 해야할 문서
@struct 구조체 정의
@todo 앞으로 해야할 일
@version 버전
@warning 주의 사항

3.1 파일 주석

키워드가 저것 말고도 많지만, 써봤자 안본다.
파일 상단에는