Doxygenは、ライブラリ/プログラムのAPIの一部ではないカスタムページを作成するためにも使用できます。これらのページの目的は、ユーザーが役立つと思う他のものでドキュメントを充実させることです。
カスタムページを作成するには、サポートされているファイル拡張子（.dox、.txt、または.md）のいずれかを使用します。Doxygenは、.doxまたは.txtファイルをC/C++ソースファイルとして、.mdファイルをMarkdownファイルとして扱います。
.doxまたは.txtファイルの場合、次のように単一のDoxygenコメントを使用できます。
manual/index.dox
\mainpageコマンドが使用されていることに気付くでしょう。これはDoxygenにこのページをメインページとして使用するように指示するものです。他のページでは、\pageコマンドをプレフィックスとして付けてください。
デフォルトでは、Doxygenはこれらのカスタムファイルについて認識しないため、DoxyfileのINPUT属性を介してそれを知らせる必要があります。例のaboutについては、次の行を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コマンドを使用すると、さまざまなトピック間にリンクを追加でき、そうすることでツリービューが自動的に作成され始めます。
ツリーが葉っぱの山のように見える場合は、Subpagingを確認することで改善できます。
この説明は、ドキュメントを充実させるためのスケーラブルなマニュアルを構築する方法について、ある程度の方向性を示すはずです。ここから、レイアウトをカスタマイズすることもできます。
1.13.0