回答:
mainpage
コマンドを見てください。
また、この回答を別のスレッドでご覧ください:Doxygenにカスタムファイルを含める方法。これは3つの拡張機能doxygenを追加ドキュメントファイルなどのクラスがあると述べている:.dox
、.txt
と.doc
。これらの拡張子が付いたファイルはファイルインデックスには表示されませんが、最終的なドキュメントに追加情報を含めるために使用できます-必要なドキュメントに非常に役立ちますが、ソースコードに含めるのは適切ではありません(たとえば、FAQ)
したがって、mainpage.dox
SDKを紹介するために、プロジェクトディレクトリに(または同様の名前の)ファイルを置くことをお勧めします。このファイル内には、1つ以上のC / C ++スタイルのコメントブロックを配置する必要があることに注意してください。
.md
および.markdown
)も、追加のドキュメントファイルと見なされます。.dox
周囲のコードコメントを必要とせず、マークダウンエディターで問題なく編集できるため、私はそれらを優先します。欠点はありません。
v1.8.8以降、オプションもありますUSE_MDFILE_AS_MAINPAGE
。したがって、必ずREADME.mdなどのインデックスファイルを追加しINPUT
て、このオプションの値として設定してください。
INPUT += README.md
USE_MDFILE_AS_MAINPAGE = README.md
USE_MDFILE_AS_MAINPAGE
私にとってはうまくいきませんでした。ドキュメントによると、{#mainpage}
マークダウンドキュメントのタイトルの後に含める必要があります。これはうまくいきました。
INPUT = README.md
そのときINPUT += src
(@Lesterの提案に従うため)を使用しただけで、それUSE_MDFILE_AS_MAINPAGE = README.md
は魅力のように機能しました。バージョン:私に$ doxygen --version
戻ります1.8.11
。
Doxygenリリース1.8.0では、Markdown形式のページを追加することもできます。これを機能させるには.md
、.markdown
拡張子がorのページを作成し、以下を構成ファイルに追加する必要があります。
INPUT += your_page.md
FILE_PATTERNS += *.md *.markdown
詳細については、http://www.doxygen.nl/manual/markdown.html#md_page_headerを参照してください。
dox=md
ようEXTENSION_MAPPING
に、あなたの値下げ拡張をし、名前の変更.dox
設定は次のようになります。だから:INPUT += your_page.dox EXTENSION_MAPPING += dox=md
次の構文は、doxygenのメインページと関連するサブページを追加するのに役立ちます。
/*! \mainpage Drawing Shapes
*
* This project helps user to draw shapes.
* Currently two types of shapes can be drawn:
* - \subpage drawingRectanglePage "How to draw rectangle?"
*
* - \subpage drawingCirclePage "How to draw circle?"
*
*/
/*! \page drawingRectanglePage How to draw rectangle?
*
* Lorem ipsum dolor sit amet
*
*/
/*! \page drawingCirclePage How to draw circle?
*
* This page is about how to draw a circle.
* Following sections describe circle:
* - \ref groupCircleDefinition "Definition of Circle"
* - \ref groupCircleClass "Circle Class"
*/
次のようにグループを作成すると、ページのデザインにも役立ちます。
/** \defgroup groupCircleDefinition Circle Definition
* A circle is a simple shape in Euclidean geometry.
* It is the set of all points in a plane that are at a given distance from a given point, the centre;
* equivalently it is the curve traced out by a point that moves so that its distance from a given point is constant.
* The distance between any of the points and the centre is called the radius.
*/
コンテンツを含むドキュメントにファイルを追加します(例:toc.h)。
@ mainpage Manual SDK
<hr/>
@ section pageTOC Content
-# @ref Description
-# @ref License
-# @ref Item
...
そしてあなたの中でDoxyfile
:
INPUT = toc.h \
例(ロシア語):
上記すべてをv 1.8.13で試しましたが、うまくいきませんでした。私(macOS上)で機能したのは、doxywizard-> Expertタグを使用してUSE_MD_FILE_AS_MAINPAGE
設定を入力することでした。
Doxyfileに次の変更を加えました。
USE_MDFILE_AS_MAINPAGE = ../README.md
...
INPUT = ../README.md \
../sdk/include \
../sdk/src
の行の終端に注意してくださいINPUT
。ドキュメントで指定されているように、セパレーターとしてスペースを使用していました。AFAICTこれは、動作していないバージョンと動作しているバージョンのDoxyfileの間の唯一の変更です。