1. ホーム
  2. doxygen

[解決済み] Doxygenで紹介ページを作成する方法

2022-09-02 17:42:11

質問

Doxygenを使って、SDKのドキュメントを作りました。これには、ファイル、名前空間、クラス、型などのリストが含まれています。- 私が Doxygen のコメントとしてコードに配置したすべてのものです。ここで、どのコード要素にも直接関係しない、SDKに関する一般的な情報(イントロダクションのようなもの)を書きたいと思います。私はこの紹介をドキュメントの開始ページに置きたいと思います。どのようにすればよいのでしょうか?

どのように解決するのですか?

このページでは mainpage コマンドを使用してください。

また、別のスレッドに対するこの回答も見てください。 Doxygenでカスタムファイルをインクルードする方法 . これによると、doxygenが追加ドキュメントファイルとして分類している拡張子は3つあるそうです。 .dox , .txt.doc . これらの拡張子を持つファイルはファイルインデックスには表示されませんが、最終的なドキュメントに追加情報を含めるために使用することができます - 必要ではあるがソースコードに含めるのはあまり適切ではないドキュメント (例えば FAQ) に非常に便利です。

ですから、私は mainpage.dox (または似たような名前の) ファイルをプロジェクトディレクトリに置いて、SDKを紹介することをお勧めします。このファイルには、1つ以上のC/C++スタイルのコメントブロックを入れる必要があることに注意してください。