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

最初のパートはユーザーマニュアルです

  • セクション インストール では、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-2024 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を作成する上で良いスタートを切ることができました。
  • 美しいGUIツールキットを作成してくれたQt Softwareのすべての人々に。
  • 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に。 多くの言語への翻訳を提供してくれたすべての言語メンテナーに。
  • 提案、パッチ、およびバグレポートをくれた他の多くの人々。

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

Heers