web-dev-qa-db-ja.com

Doxygenにカスタムファイルを含める方法

Doxygen で追加のページを生成するカスタム（非プロジェクト）ファイルを追加したいと思います。

私は（実際には）これらのファイルにどのように名前を付け、どのようにコンテンツをフォーマットするべきかわからない。

doxygen
46
Veger

答えを見つける前にかなり検索していたので、共有するのがいいと思いました！

これによると Doxygen gotchas の記事でようやくわかりました：dox拡張子のファイルを追加する必要があります。そのコンテンツには、Cスタイルのコメントブロックが含まれている必要があります。

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

カスタムファイルが [〜＃〜] input [〜＃〜] 設定に含まれているディレクトリ、またはINPUTが空のままの場合は現在のディレクトリに配置されていることを確認してください。 。

48
Veger

完全を期すために、doxygenが追加のドキュメントファイルとして扱う3つの可能な拡張子があります：.dox、.txt、および.doc。

そのような拡張子がファイルインデックスから隠されているファイル。ファイル内に、1つ以上のC/C++スタイルのコメントブロックを配置する必要があります。

40
doxygen

さらに完全にするために、Doxygenバージョン1.8（私は信じる）から、 markdown 構文に非常に類似した追加のテキストファイルをサポートするようになりました。 C/C++スタイルのコメントブロックを使用する必要はなくなりました。代わりに、almost通常のテキストを記述し、テキストファイルがINPUTパスにあり、doxygenスキャンが実際に.markdownでファイルを探すことを確認してください拡張子（または.mdなど、使用することを選択したその他の拡張子）。

16
DXM

明確にするために：

.dox構成ファイルで、次のようなファイルをINPUTディレクティブに追加します。

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

ファイルに.hや.cなどの適切な拡張子がある場合、DoxygenはINPUTディレクティブに追加せずにファイルを見つけます。ファイル内では、ソースのように通常のDoxygenタグを使用します。つまり、次のようなコメントブロック内で使用します。

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

上記の例の「\ htmlinclude」のように、コード内の任意の場所でincludeタグの1つを使用することもできます。

11
Wiley

DoxyfileのINPUTマクロにカスタムファイルをリストするだけです。適切な名前を選択できます。形式は、Doxygenタグ付きのテキストです。

2
mouviciel