Doxyen 을 이용하여 오픈소스인 QT 에 대해서 문서화를 진행해보도록 하겠습니다. Doxygen 1.5.0 버전을 이용하여 QT 4.3.0 윈도우 버전의 소스코드에 대해서 문서화를 진행하였습니다.
QT는 Trolltech 에서 진행하는 오픈소스프로젝트로 Windows/Linux/Mac 에서 모두 컴파일 가능한 라이브러리 입니다. 일반적인 GUI 프로그램 개발이 가능하며, Socket, Thread 등의 모든 기능을 제공하고 있습니다. Cross Compile 라는 장점을 잘 활용한다면 모든 플랫폼에서 동작하는 애플리케이션을 개발할 수 있을겁니다. QT 괜찮은 라이브러리 입니다.
QT 의 소스코드를 살펴보면 알겠지만, 소스코드에 포함되어 있는 주석의 형식은 Doxygen 에서 인식가능한 형태로 되어 있습니다. 때문에 Doxygen 을 이용한 문서화를 진행할 수 있습니다.
QT 소스코드 압축해제부터 Doxygen 셋팅 그리고 문서화까지 진행해보도록 하겠습니다.
1. QT 다운로드 & 압축풀기
QT 4.3.0 윈도우버전 소스코드 다운로드
다운로드된 QT 소스코드를 다음의 경로에서 압축을 풀어봤습니다.
C:\qt-win-opensource-src-4.3.0
2. Doxygen 셋팅
QT 를 다운로드 받으면 이미 HTML 로 만들어진 문서가 포함되어 있습니다. 하지만 어디까진 Doxygen 이용을 위한 테스트가 목적이기 때문에 무시하고 진행해 보도록 하겠습니다.
Wizard 버튼을 눌러서 다음과 같은 셋팅을 하도록 합니다.
Output Format 을 HTML 만 선택하고 검색기능을 Check 하도록 합니다. 웹 퍼블리싱만 할것이기 때문에 LaTex 는 필요가 없을듯 합니다.
위와 같이 셋팅이 되었다면 OK 버튼을 누르고 Save 버튼을 눌러서 셋팅을 저장합니다. Save 의 Status 가 Saved 가 되었다면, Step3 으로 넘어가서 Working Directory 를 다음과 같이 설정합니다.
Working Directory : C:/qt-win-opensource-src-4.3.0/doxygen
3. Doxygen 실행
Start 버튼을 눌러서 문서화를 시작합니다. 파일들이 꽤 많기 때문에 시간이 오래걸립니다. 잠시 딴짓을 하는것이 좋은 선택이라고 보여집니다.
4. 문서화 확인
C:\qt-win-opensource-src-4.3.0\doxygen\html 경로에 HTML 파일들이 생긴걸 확인할 수 있습니다. 생성된 파일들의 용량을 확인해보니 대략 50MB 정도 나오네요. 꽤 많은 용량이라고 볼 수 있겠습니다.
5. 웹 퍼블리싱
생성된 HTML 파일을 웹서버에 업로드하였습니다. 다음의 경로를 통해서 생성된 결과물을 확인할 수 있습니다. [ 바로가기 ]
기본적인 문서화를 진행해 보았습니다. 문서화를 할 내용이 많아서 그런지 조금 느리다는 점 빼고는 모든게 성공적으로 진행되었네요.
QT는 Trolltech 에서 진행하는 오픈소스프로젝트로 Windows/Linux/Mac 에서 모두 컴파일 가능한 라이브러리 입니다. 일반적인 GUI 프로그램 개발이 가능하며, Socket, Thread 등의 모든 기능을 제공하고 있습니다. Cross Compile 라는 장점을 잘 활용한다면 모든 플랫폼에서 동작하는 애플리케이션을 개발할 수 있을겁니다. QT 괜찮은 라이브러리 입니다.
QT 의 소스코드를 살펴보면 알겠지만, 소스코드에 포함되어 있는 주석의 형식은 Doxygen 에서 인식가능한 형태로 되어 있습니다. 때문에 Doxygen 을 이용한 문서화를 진행할 수 있습니다.
QT 소스코드 압축해제부터 Doxygen 셋팅 그리고 문서화까지 진행해보도록 하겠습니다.
1. QT 다운로드 & 압축풀기
QT 4.3.0 윈도우버전 소스코드 다운로드
다운로드된 QT 소스코드를 다음의 경로에서 압축을 풀어봤습니다.
C:\qt-win-opensource-src-4.3.0
2. Doxygen 셋팅
QT 를 다운로드 받으면 이미 HTML 로 만들어진 문서가 포함되어 있습니다. 하지만 어디까진 Doxygen 이용을 위한 테스트가 목적이기 때문에 무시하고 진행해 보도록 하겠습니다.
Wizard 버튼을 눌러서 다음과 같은 셋팅을 하도록 합니다.
Source code directory : C:\qt-win-opensource-src-4.3.0\src
Destination directory : C:\qt-win-opensource-src-4.3.0\doxygen
Scan recursively 를 체크해 주세요.
Output Format 을 HTML 만 선택하고 검색기능을 Check 하도록 합니다. 웹 퍼블리싱만 할것이기 때문에 LaTex 는 필요가 없을듯 합니다.
위와 같이 셋팅이 되었다면 OK 버튼을 누르고 Save 버튼을 눌러서 셋팅을 저장합니다. Save 의 Status 가 Saved 가 되었다면, Step3 으로 넘어가서 Working Directory 를 다음과 같이 설정합니다.
Working Directory : C:/qt-win-opensource-src-4.3.0/doxygen
3. Doxygen 실행
Start 버튼을 눌러서 문서화를 시작합니다. 파일들이 꽤 많기 때문에 시간이 오래걸립니다. 잠시 딴짓을 하는것이 좋은 선택이라고 보여집니다.
4. 문서화 확인
C:\qt-win-opensource-src-4.3.0\doxygen\html 경로에 HTML 파일들이 생긴걸 확인할 수 있습니다. 생성된 파일들의 용량을 확인해보니 대략 50MB 정도 나오네요. 꽤 많은 용량이라고 볼 수 있겠습니다.
5. 웹 퍼블리싱
생성된 HTML 파일을 웹서버에 업로드하였습니다. 다음의 경로를 통해서 생성된 결과물을 확인할 수 있습니다. [ 바로가기 ]
기본적인 문서화를 진행해 보았습니다. 문서화를 할 내용이 많아서 그런지 조금 느리다는 점 빼고는 모든게 성공적으로 진행되었네요.
TRACKBACK(s)
Trackback Address: http://www.rainless.com/blog/trackback/143
COMMENT(s)
RSS
