[Tool] Mac 에서 Doxygen 간단 사용방법

Doxygen 은 소스코드를 문서화 해주는 툴이고

공식 홈페이지는 아래와 같다.
http://www.stack.nl/~dimitri/doxygen/index.html

Mac용 Doxygen 은 아래주소에서 받으면 된다.
http://sourceforge.net/projects/doxygen/

다운 받고 설치 한다음에 실행하면
아래같은 화면이 나온다.

1 : 문서화 할 원본 소스코드의 경로
2 : 스캔할 소스코드의 경로
3 : 문서화 한 파일들이 저장될 경로

그다음 왼쪽 메뉴중에 Mode 를 선택하면
아래처럼 나온다.

빨간색 박스에서 소스코드가 어떤 언어로 되어 있는지 선택하면 된다.

그다음 Step 2 에 있는 탭 중에
Run 을 선택하고 Run doxygen 버튼을 누르면
문서화가 자동으로 진행 된다.

문서화가 완료된 후에 
열어보면 아래처럼 잘 빠져 나온다.

주석은

/**
*/
안에 여러줄을 넣어도 되고

///
이렇게 한줄로도 사용 가능하다.

( Ex )
한줄 짜리

/// @brief : 싱글톤 객체 protected static T _instance; 

여러줄 사용할 때

/** @brief : 싱글톤 제거 */ public static void PurgeInstance() { if ( _instance != null ) { Destroy (_instance.gameObject); } }