Doxygen はコマンドラインベースのユーティリティです。コマンドラインで doxygen を --help オプション付きで呼び出すと、プログラムの使用法に関する簡単な説明が表示されます。

すべてのオプションは、先頭文字 - に続き、1文字と、オプションに応じて1つ以上の引数で構成されます。

プロジェクトのマニュアルを生成するには、通常、以下の手順を実行する必要があります。

ソースコードを特別なドキュメントブロックでドキュメント化します（セクション特殊コメントブロックを参照）。
Doxygen を -g オプションで呼び出して、設定ファイルを生成します（セクション設定を参照）。
```
doxygen -g <config_file>
```
設定ファイルを編集して、プロジェクトに合わせます。設定ファイルでは、入力ファイルと多くのオプション情報を指定できます。
Doxygen に、設定ファイルの設定に基づいてドキュメントを生成させます。
```
doxygen <config_file>
```

Doxygen の古いバージョンで生成された設定ファイルがある場合、-u オプションで Doxygen を実行することにより、現在のバージョンにアップグレードできます。

doxygen -u <config_file>

元の設定ファイル内のすべての設定は、新しい設定ファイルにコピーされます。新しいオプションには、その既定値が設定されます。元の設定ファイルに追加した可能性のあるコメントは失われることに注意してください。

出力の微調整

出力の外観を微調整したい場合、Doxygen はデフォルトのスタイルシート、ヘッダー、およびフッターファイルを生成でき、これらを後で編集できます。

HTML 出力の場合、以下のコマンドを使用して、デフォルトのヘッダーファイル（HTML_HEADER を参照）、デフォルトのフッター（HTML_FOOTER を参照）、およびデフォルトのスタイルシート（HTML_STYLESHEET を参照）を生成できます。
```
doxygen -w html header.html footer.html stylesheet.css <config_file>
```
config_file はオプションです。省略された場合、Doxygen は Doxyfile という名前のファイルを検索し、それを処理します。それも見つからない場合は、デフォルトの設定が使用されます。
出力の場合、以下のコマンドを使用して、refman.tex の最初と最後の部分（LATEX_HEADER および LATEX_FOOTER を参照）と、そのヘッダーに含まれるスタイルシート（通常は doxygen.sty）を生成できます。
```
doxygen -w latex header.tex footer.tex doxygen.sty <config_file>
```
デフォルト以外のオプションが必要な場合（例えば、追加のパッケージを使用する場合など）、それらのオプションが正しく設定された設定ファイルを作成し、生成されたファイルの後にその設定ファイルを指定する必要があります（出力ファイルのいずれかを指定し忘れた場合に備えて、最初に設定ファイルのバックアップを取っておいてください）。
RTF 出力の場合、以下の方法でデフォルトのスタイルシートファイル（RTF_STYLESHEET_FILE を参照）を生成できます。
```
doxygen -w rtf rtfstyle.cfg
```

警告: カスタムヘッダーを使用する場合、Doxygen が必要とするスクリプトおよびスタイルシートの適切なインクルードは、お客様の責任となります。これらは設定オプションに依存し、新しい Doxygen リリースにアップグレードする際に変更される可能性があります。

注

設定ファイル内の各項目に関するドキュメントが不要な場合は、オプションの -s オプションを使用できます。これは -u オプションと組み合わせて、既存の設定ファイルからドキュメントを追加または削除するために使用できます。最小限の設定ファイルを取得するには、デフォルトの Doxygen 設定ファイルからの差分のみを表示する -x または -x_noenv オプションを使用してください。バグ報告の一部として設定ファイルを送信する場合や、GitHub に問題を投稿する場合は、-s または -x または -x_noenv オプションを使用してください！（参照：バグの報告方法）
Doxygen にファイルから/へではなく、標準入力/出力に読み書きさせるには、ファイル名に - を使用します。

次のセクションへ進むか、目次に戻る。