ドキュメント 変更履歴 拡張機能 例  
概要

最初のパートはユーザーマニュアルを構成します

  • セクション「インストール」では、お使いのプラットフォームに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ライセンス

Copyright © 1997-2025 by Dimitri van Heesch.

GNU General Public Licenseの条項に基づき、本ソフトウェアおよびそのドキュメントを使用、コピー、変更、配布する許可がここに付与されます。本ソフトウェアが特定の目的に適合することについて、いかなる表明も行いません。明示的または黙示的な保証なしに「現状有姿」で提供されます。詳細については、GNU General Public Licenseを参照してください。

Doxygenによって生成されたドキュメントは、その生成に使用された入力から派生した二次的著作物であり、このライセンスの影響を受けません。

ユーザー例

Doxygenは、HTMLが最も一般的なものとして、いくつかの出力フォーマットをサポートしています。Doxygenを使用している実際のプロジェクトの素晴らしい例をいくつか集めました。

これらは、Doxygenを使用しているより大規模なプロジェクトリストの一部です。他にもプロジェクトをご存知でしたら、私にお知らせください。追加します。

今後の作業

Doxygenはすでに多数の企業やオープンソースプロジェクトで成功裏に使用されていますが、常に改善の余地があります。

機能強化のリクエストは、バグトラッカーからも提出できます。

謝辞

以下の方々に感謝の意を表します

  • Malte Zöckler および Roland Wunderling、DOC++ の著者。Doxygenの最初のバージョンは、DOC++の古いバージョンから一部のコードを借用しました。それ以来、私は実質的にすべてのコードを書き直しましたが、DOC++はDoxygenの執筆において良い出発点を与えてくれました。
  • Qt Softwareの皆様、美しいGUIツールキットを作成していただきありがとうございます。
  • Steffen Schümann、Doxygenで使用されている ghc::filesystem を作成していただきありがとうございます。
  • Michael McTernan、現在Doxygenに組み込まれている mscgen を作成していただきありがとうございます。
  • 私の兄弟Frank、ロゴをレンダリングしていただきありがとうございます。
  • Harm van der Heijden、HTMLヘルプサポートを追加していただきありがとうございます。
  • Wouter Slegers、www.doxygen.org ドメインを登録していただきありがとうございます。
  • Martin Kreis、VHDLサポートを追加していただきありがとうございます。
  • Parker Waechter、RTF出力ジェネレーターを追加していただきありがとうございます。
  • Joerg Baumann、条件付きドキュメントブロック、PDFリンク、および設定ジェネレーターを追加していただきありがとうございます。
  • Tim Mensch、todoコマンドを追加していただきありがとうございます。
  • Christian Hammond、ウェブサイトを再設計していただきありがとうございます。
  • Ken Wong、HTMLツリービューコードを提供していただきありがとうございます。
  • Talin、XMLマークアップ付きのC#スタイルコメントのサポートを追加していただきありがとうございます。
  • Petr Prikryl、国際化サポートを調整していただきありがとうございます。多くの言語に翻訳を提供してくださったすべての言語メンテナーの皆様にも感謝いたします。
  • その他多数の皆様、提案、パッチ、バグ報告をありがとうございます。

スポンサーリンク
(doxygenとは関係ありません)

Heers