Doxygen에 사용자 정의 파일을 포함하는 방법

Question

Doxygen으로 일부 추가 페이지를 생성하기 위해 사용자 정의 (비 프로젝트) 파일을 추가하고 싶습니다.

나는 실제로 이러한 파일의 이름을 지정해야하며 내용의 형식을 지정해야합니다.

Answer 1

나는 대답을 찾기 전에 꽤 많은 것을 찾고 있었기 때문에 나눌 생각이 듭니다. 당신이 DOX 확장자를 가진 파일을 추가해야합니다 드디어 발견이 Doxygen gotchas 기사에 따르면

.

/*! 
    \page My test page 
    contents 
    ... 
    more contents 
*/ 

사용자 정의 파일이 입력이 비어있는 경우 INPUT 설정 또는 현재 디렉토리에 포함 된 디렉토리에 저장되어 있는지 확인하므로 이러한 파일은 찾을 수 있습니다 그것의 내용은 C 스타일 주석 블록을 포함해야 .

Answer 2

사용자 정의 파일을 doxyfile의 INPUT 매크로에 나열하면됩니다. 적절한 이름을 선택할 수 있습니다. 형식은 Doxygen 태그가있는 텍스트입니다.

Answer 3

doxygen이 추가 문서 파일로 취급 할 수있는 확장자는 .dox, .txt 및 .doc의 3 가지입니다.

이러한 확장자가 파일 색인에서 숨겨진 파일입니다. 파일 안에는 하나 이상의 C/C++ 스타일 주석 블록을 넣어야합니다.

Answer 4

Doxygen 버전 1.8 (필자는 믿을 만하다.)부터는 markdown 구문과 매우 유사한 추가 텍스트 파일을 지원합니다. 더 이상 C/C++ 스타일 주석 블록을 사용할 필요가 없습니다. 대신 을 거의 일반 텍스트로 작성하고 텍스트 파일이 INPUT 경로에 있는지 확인하고 doxygen 스캔이 실제로 .markdown 확장자 (또는 .md와 같이 사용하도록 선택한 다른 확장자)가있는 파일을 찾습니다.

명확성을 위해

Answer 5

:

.dox 구성 파일에서

, 이런 식 으로 입력 지시에 파일을 추가합니다

INPUT = ../src \ 
     ../include \ 
     ../docs/my-extra-file.txt 

를 파일이 적절한 확장이 있다면, .H 같은 말 또는 .c 다음 Doxygen은 INPUT 지시어에 추가하지 않고 파일을 찾습니다.

/*! \mainpage MyProject - A Brief Description. 
\image html Mylogo.png 
\section my-intro MyProject Introduction 
\htmlinclude about-MyProject.html 
*/ 

한도 바로 위의 예에서 "\ htmlinclude"같은 포함 태그 중 하나를 사용할 수 있습니다, 어떤 : 파일 내부와 같은 주석 블록 내부, 즉 소스의 정상 Doxygen을 태그, 사용 코드에서.