最初の部分はユーザーマニュアルを形成します。
- セクション インストール では、Doxygenをプラットフォーム用に ダウンロード、コンパイル、インストールする方法について説明します。
- セクション はじめに では、最初のドキュメントを素早く生成する方法について説明します。
- セクション コードのドキュメント化 では、コードをドキュメント化する様々な方法を実演します。
- セクション Markdown サポート では、Doxygen がサポートする Markdown 形式を示します。
- セクション リスト では、リストを作成する方法を示します。
- セクション グループ化 では、物事をグループ化する方法を示します。
- セクション テーブルの挿入 では、ドキュメントにテーブルを挿入する方法を示します。
- セクション 数式の挿入 では、ドキュメントに数式を挿入する方法を示します。
- セクション グラフと図 では、Doxygen が生成できる図とグラフについて説明します。
- セクション プリプロセッシング では、Doxygen がマクロ定義をどのように処理するかを説明します。
- セクション 自動リンク生成 では、ドキュメントにファイル、クラス、およびメンバーへのリンクを配置する方法を示します。
- セクション 出力フォーマット では、Doxygen がサポートする様々な出力フォーマットを生成する方法を示します。
- セクション 検索 では、HTML ドキュメントを検索する様々な方法を示します。
- セクション 外部インデックス作成と検索 では、外部検索およびインデックスツールを使用する方法を示します。
- セクション 追加ドキュメント では、API に関連しないドキュメントページを作成する方法を説明します。
- セクション 出力のカスタマイズ では、Doxygen が生成する出力をカスタマイズする方法を説明します。
- セクション カスタムコマンド では、コメントでカスタムコマンドを定義および使用する方法を示します。
- セクション 外部ドキュメントへのリンク では、Doxygen に外部で生成されたドキュメントへのリンクを作成させる方法を説明します。
- セクション よくある質問 では、よくある質問に対する回答を提供します。
- セクション トラブルシューティング では、問題が発生した場合の対処法について説明します。
2番目の部分はリファレンスマニュアルを形成します。
- セクション 機能 では、Doxygen ができることの概要を説明します。
- セクション Doxygen の使い方 では、
doxygen プログラムの使い方を示します。
- セクション Doxywizard の使い方 では、
doxywizard プログラムの使い方を示します。
- セクション 設定 では、目的のドキュメントを生成するように Doxygen を微調整する方法を示します。
- セクション 特殊コマンド では、ドキュメント内で使用できる特殊コマンドの概要を示します。
- セクション HTML コマンド では、ドキュメント内で使用できる HTML コマンドの概要を示します。
- セクション XML コマンド では、ドキュメント内で使用できる C# スタイルの XML コマンドの概要を示します。
- セクション 絵文字サポート では、ドキュメント内で絵文字を使用する方法の紹介を示します。
3番目の部分は開発者向けの情報を提供します。
- セクション Doxygen の内部構造 では、Doxygen が内部的にどのように構造化されているかの全体像を説明します。
- セクション Perl モジュール出力 では、PerlMod 出力を使用する方法を示します。
- セクション 国際化 では、新しい出力言語のサポートを追加する方法を説明します。
Doxygen ライセンス
著作権 © 1997-2025 by Dimitri van Heesch。
このソフトウェアとそのドキュメントを GNU General Public License の条項に基づいて使用、コピー、変更、配布する許可がここに付与されます。このソフトウェアが特定の目的に適していることについて、いかなる表明も行いません。明示的または黙示的な保証なしに「現状有姿」で提供されます。詳細については、GNU General Public License を参照してください。
Doxygen によって生成されたドキュメントは、その生成に使用された入力から派生した派生著作物であり、このライセンスの影響を受けません。
ユーザー例
Doxygen は、HTML が最も人気のある 出力フォーマット を数多くサポートしています。Doxygen を使用している実際のプロジェクトの いくつかの良い例 を集めました。
これらは、Doxygen を使用しているより大きな プロジェクトのリスト の一部です。もし他のプロジェクトをご存知でしたら、私 にお知らせください。追加いたします。
今後の作業
Doxygen はすでに多数の企業やオープンソースプロジェクトで成功裏に使用されていますが、常に改善の余地があります。
バグトラッカー で機能強化のリクエストを提出することもできます。
謝辞
以下の皆様に感謝いたします。
-
DOC++ の著者である Malte Zöckler と Roland Wunderling。Doxygen の最初のバージョンは、古いバージョンの DOC++ の一部のコードを借用しました。その後、私はほとんどすべてのコードを書き直しましたが、DOC++ は Doxygen の作成において良い出発点を与えてくれました。
- Qt Software のすべての関係者の皆様、美しい GUI ツールキットを作成していただきありがとうございます。
- Doxygen で使用されている ghc::filesystem を作成した Steffen Schümann 氏。
- 現在 Doxygen に組み込まれている mscgen を作成した Michael McTernan 氏。
- ロゴをレンダリングしてくれた弟の Frank。
- HTML ヘルプサポートを追加した Harm van der Heijden 氏。
- www.doxygen.org ドメインを登録した Wouter Slegers 氏。
- VHDL サポートを追加した Martin Kreis 氏。
- RTF 出力ジェネレーターを追加した Parker Waechter 氏。
- 条件付きドキュメントブロック、PDF リンク、および設定ジェネレーターを追加した Joerg Baumann 氏。
- todo コマンドを追加した Tim Mensch 氏。
- ウェブサイトを再設計した Christian Hammond 氏。
- HTML ツリービューコードを提供した Ken Wong 氏。
- XML マークアップ付きの C# スタイルコメントのサポートを追加した Talin 氏。
- 国際化サポートを調整してくれた Petr Prikryl 氏。多くの言語への翻訳を提供してくれたすべての言語メンテナー。
- 提案、パッチ、バグレポートを提供してくれたその他大勢の方々。