Doxygenは、ライブラリやプログラムのAPIの一部ではないカスタムページを作成するためにも使用できます。そのようなページの目的は、ユーザーが役立つと思われるその他の情報でドキュメントを充実させることです。
カスタムページを作成するには、サポートされているファイル拡張子のいずれかを使用します。.dox、.txt、または.md。Doxygenは、.doxまたは.txtファイルをC/C++ソースファイルとして扱い、.mdファイルをMarkdownファイルとして扱います。
.doxまたは.txtファイルの場合、次のように単一のDoxygenコメントを使用できます。
manual/index.dox
\mainpage コマンドが使用されていることに注意してください。これはDoxygenにこのページをメインページとして使用するように指示します。他のページについては、\page コマンドを接頭辞として付けてください。
デフォルトではDoxygenはこれらのカスタムファイルを認識しないため、DoxyfileのINPUT属性を介してDoxygenに知らせる必要があります。上記の例については、この行をDoxyfileに追加してください。
次に、プロジェクトをビルドする方法の手順を追加したい場合があります。そのため、manual/building/index.doxを作成します。ドキュメントをさらに読み進めると、DoxygenがHTMLタグの一部をサポートしていることがわかります。したがって、次のように記述できます。
しかしもちろん、一般的なMarkdown記法を使用して同じこともできます。
# Building
## Linux
A simple way to build this project is with cmake, clone the repository,
cd into the root of the project and run:
mkdir my_build
cmake -S . -B my_build
cd my_build
cmake --build .
この時点で、manual/building/index.doxをカンマ区切りでINPUTに追加することもできますが、マニュアルを構築するにつれてこれは時間の経過とともに煩わしくなる可能性があります。代わりに、マニュアルフォルダを参照するように変更します。
そして設定します。
組織とコンテンツをさらに作成する際に、マニュアルのサブディレクトリを追加するときに確実に含めるためです。
マニュアルが拡大するにつれて、整理された状態を保つために、マニュアル内で現在どこにいるかを示す便利なツリービューも欲しくなるかもしれません。これは簡単に設定でき、次のようにして有効にします。
あなたのDoxyfileで。
manual/index.doxファイルは、どこにもリンクが張られておらず、かなり単調だったことを思い出してください。\ref コマンドを使用することで、さまざまなトピック間にリンクを追加でき、そうすることで自動的にツリービューが生成され始めます。
ツリーが葉の山のように見える場合は、サブページングを確認することでこれを改善できます。
この議論は、ドキュメントを充実させるためのスケーラブルなマニュアルを構築する方法について、いくつかの方向性を提供するはずです。ここから、レイアウトをカスタマイズしたいと思うかもしれません。
1.14.0