Doxygen 학습 총화(1)

1.Doxygen 은 원본 패 키 지 를 분석 하고 문 서 를 만 드 는 도구 입 니 다.원본 코드 의 주석 에 의 해 Doxygen 은 다양한 형식의 도움말 문 서 를 쉽게 생 성 할 수 있 습 니 다.Qt 의 qdoc3.exe(Qt 도움말 문서 생 성 도구)기능 과 유사 합 니 다.
2.유 닉 스(Liux 포함),windows 가족,Mac 시스템 등 대부분의 운영 체제 에서 실행 할 수 있 습 니 다.
3.지원 C /C++, Java, Objective-C , Python，Fortran, VHDL,IDL(Corba 와 Microsoft 가족 PHP， C#。
4.출력 형식 은 HTML,latex,RTF,ps,PDF,압축 된 HTML 과 유 닉 스 를 포함한다. manpage。
 
Doxygen 운행 에는 두 가지 조건 이 필요 합 니 다.
a.주석 소스 코드 가 있 으 면 Qt 주석 스타일,자바 Doc 스타일 등 을 사용 할 수 있 습 니 다.
b.설정 파일 이 있 으 면 Doxygen 의 전단 인터페이스 Doxy Wizard 를 통 해 생 성 할 수 있 고 전단 인터페이스 에서 Doxygen 을 호출 하여 도움말 문 서 를 생 성 할 수 있 으 며 cmd 를 통 해 스스로 호출 할 수 있 습 니 다.
 
Doxy Wizard 는 Qt 로 작 성 된 인터페이스 로 네 개의 모듈 로 나 뉜 다.
step 1:doxygen 의 경로.
step2 ：
             마법사(마법사)  매우 편리 한 가이드.기본 프로필 을 만 들 수 있 습 니 다.
             Expert(전문가)모든 프로필 의 속성 은 스스로 정의 합 니 다.(프로필 설명,매 뉴 얼 이나 마우스 가 지나 갈 때 왼쪽 아래 에 있 는 설명 을 볼 수 있 습 니 다.속성의 오른쪽 단 추 를 누 르 면 기본 값 을 회복 할 수 있 습 니 다).
step 3:도움말 문 서 를 만 들 고 설정 파일 의 설정 에 따라 문서 의 위치,형식 을 생 성 합 니 다.
 
Qtcreator 는 IDE 입 니 다.QtCreator 에 원본 코드 를 추가 하고 원본 도움말 문서 qch 파일 을 QtCreator 의 도움말 시스템 에 추가 하면 원본 코드 를 미 끄 러 진 class 가 class 에 나타 납 니 다.\brief 짧 은 설명 입 니 다.
Doxygen 에서 어떻게 없 을 수 있 습 니까?검색 을 통 해 qhp,qch 파일 의 문제 가 아니 라 우리 의 원래 도움말 문 서 는 qdoc 3.exe 로 생 성 된 html 파일 입 니 다.qdoc 3 에서 생 성 된 것 은\brief 의 앞 뒤 줄 에 다음 과 같이 추가 되 었 습 니 다.
클래스 QFtp html 파일,qt\doc\html\아래 파일 보기
 

<!-- $$$QFtp-brief -->
<p>The QFtp class provides an implementation of the client side of FTP protocol. <a href="#details">More...</a></p>
<!-- @@@QFtp -->

Doxygen 이 만 든 html 파일 은 이 두 마디 가 없습니다.


따라서 Doxygen 에서 생 성 된 qch 파일 은 QtCreator 도움말 시스템 에 사용 되 며 원본 파일 에 brief 알림 이 없습니다.(어 리 석 은 방법,수 동 추가)