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

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

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

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

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

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 オプションと組み合わせて使用でき、既存の設定ファイルからドキュメントを追加または削除できます。最小限の設定ファイルを取得するには、-x または -x_noenv オプションを使用して、デフォルトの Doxygen 設定ファイルとの違いのみを表示します。バグレポートの一部として設定ファイルを送る場合、または GitHub で問題を投稿する場合は、-s または -x または -x_noenv オプションを使用してください！（参照：バグを報告する方法）
Doxygen に、ファイルからではなく標準入力/出力に読み書きさせるには、ファイル名に - を使用します。

次のセクションに進むか、インデックスに戻ります。