web-dev-qa-db-ja.com

Doxygenで紹介ページを作成する方法

Doxygenを使用して、SDKのドキュメントを作成しました。ファイル、名前空間、クラス、型などのリストが含まれています-コード内でDoxygenコメントとして配置したすべてのもの。次に、SDK（導入の種類）に関する一般的な情報を記述します。これは、コード要素に直接関係しません。この紹介をドキュメントの開始ページに掲載したいと思います。これどうやってするの？

doxygen
93
Alex F

mainpage コマンドをご覧ください。

また、別のスレッドへのこの答えを見てください： Doxygenにカスタムファイルを含める方法 。 doxygenクラスが追加のドキュメントファイルとして.dox、.txt、および.docの3つの拡張機能があることを示しています。これらの拡張子を持つファイルは、ファイルインデックスには表示されませんが、最終ドキュメントに追加情報を含めるために使用できます。

したがって、SDKを紹介するために、プロジェクトディレクトリにmainpage.dox（または同様の名前の）ファイルを用意することをお勧めします。このファイル内に、1つ以上のC/C++スタイルのコメントブロックを配置する必要があることに注意してください。

87
Chris

Doxygenリリース1.8.0では、Markdown形式のページを追加することもできます。これを機能させるには、.mdまたは.markdown拡張子を持つページを作成し、構成ファイルに次を追加する必要があります。

INPUT += your_page.md
FILE_PATTERNS += *.md *.markdown

詳細については http://www.doxygen.nl/manual/markdown.html#md_page_header をご覧ください。

54
doxygen

V1.8.8現在、オプションUSE_MDFILE_AS_MAINPAGEもあります。そのため、必ずインデックスファイルを追加してください。 README.md、to INPUTに、このオプションの値として設定します。

INPUT += README.md
USE_MDFILE_AS_MAINPAGE = README.md
49
Pascal

コンテンツを含むファイルをドキュメントに追加します。たとえば、toc.h：

@ mainpage Manual SDK
<hr/>
@ section pageTOC Content
  -# @ref Description
  -# @ref License
  -# @ref Item
...

そして、あなたのDoxyfile：

INPUT = toc.h \

例（ロシア語）：

5
Denis

次の構文は、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.
 */

例はここにあります

4
Birol Capa

上記のすべてを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の行終端に注意してください。ドキュメントで指定されているように、区切り文字としてスペースを使用していました。これは、Doxyfileの動作しないバージョンと動作するバージョンとの間の唯一の変更です。

3
VorpalSword