Version: 1.2.11.1

Doxygen ライセンス

Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the GNU General Public License for more details.

Documents produced by doxygen are derivative works derived from the input used in their production; they are not affected by this license.

はじめに

Doxygen は、C++、Java、IDL (Corba、Microsoft、KDE-DCOP 風)、および C のためのドキュメンテーションシステムです。

Doxygen は、3通りの方法であなたを補助します:

ドキュメント付けがなされた一組のソースファイルから、オンラインでブラウズされるドキュメント (HTML) やオフラインのリファレンスマニュアル ( ) を生成することができます。 RTF (MS-Word)、PostScript、ハイパーリンク PDF、圧縮 HTML、そして、Unix man ページでの出力を生成することもサポートされています。ドキュメントは、ソースから直接的に抽出されます。そうすることにより、ドキュメントとソースコードの一貫性を保つことがとても容易になります。
Doxygen は、ドキュメント付けがなされていないソースファイルから、コードの構造を抽出するように設定することができます。これは、大きなソースディストリビューションにおいて、あなたが進むべき道をすばやく見つけるのに、大変役立ちます。様々な要素間の関係が、インクルード依存グラフ、継承図、およびコラボレーション図によって視覚化されます。それらの図は、すべて自動的に生成されるのです。
あなたは、doxygen を「乱用 (abuse)」して、通常のドキュメントを作成することさえできます (このマニュアルでやっているように)。

Doxygen は、Linux の下で開発されていますが、移植性が高くなるように組み立てられています。結果的に、他のほとんどの Unix 風システムでも動作します。さらには、Windows 9x/NT 用の実行ファイルも利用可能です。

このマニュアルは 3つのパートに分かれています。それぞれのパートは、さらにいくつかのセクションに分かれます。

パート 1 は、ユーザマニュアルです:

セクション Installation では、ダウンロード、コンパイル、そして、あなたのプラットフォームへの doxygen のインストールの方法について議論します。
セクションはじめようでは、まず一つのドキュメントを素早く生成するやり方を伝えます。
セクションコードをドキュメント付けするでは、コードにドキュメントを付けるための様々なやり方を例示します。
セクションリストでは、リストを作成するための様々なやり方を示します。
セクショングループ化では、物事をまとめてグループ化するやり方を示します。
セクション式のインクルードでは、ドキュメントに式を挿入するやり方を示します。
セクショングラフと図では、doxygen が生成することのできる図とグラフについて記述します。
セクション Preprocessing では、doxygen がマクロ定義をどのように扱うかを説明します。
セクション Linking to external documentation では、外部で生成されたドキュメントへのリンクを作成するやり方について説明します。
セクション Frequently Asked Questions では、頻繁に尋ねられる質問に対して回答を与えます。
セクション Troubleshooting では、問題が生じた時に何をすべきかを伝えます。

パート 2 は、リファレンスマニュアルです:

セクション Features では、doxygen に出来ることについて総覧します。
セクション Doxygen History では、 doxygen の開発の間に変化した事、および、今なお、なされるべき事を示します。
セクション Doxygen usage では、doxygen プログラムの使い方を示します。
セクション Doxytag usage では、doxytag プログラムの使い方を示します。
セクション Doxysearch usage では、doxysearch プログラムの使い方を示します。
セクション Doxywizard usage では、doxywizard プログラムの使い方を示します。
セクション Installdox usage では、タグファイルを使用した場合に doxygen によって生成される installdox スクリプトの使い方を示します。
セクション Output Formats では、 doxygen のサポートする様々な出力フォーマットを生成するやり方について示します。
セクションリンクの自動生成では、ドキュメント内での、ファイル、クラス、およびメンバーへのリンクの張り方について示します。
セクション設定では、 doxygen を微調整して、望みのドキュメントを生成するやり方を示します。
セクション専用コマンドでは、ドキュメント内部で使用される専用コマンドについて、総覧を示します。
セクション HTML コマンドでは、ドキュメント内部で使用される HTML コマンドについて、総覧を示します。

パート3では、開発者のための情報を提供します:

セクション Doxygen's Internals では、doxygen の内部構造についての概観を与えます。
セクション Internationalization では、新しい出力用言語のサポートを追加するやり方について説明します。

doxygen を使用しているプロジェクト

作者は、 doxygen を使用しているプロジェクトのリスト that use doxygen. をまとめています。もし他のプロジェクトをご存じなら、リストに追加しますので、作者までお知らせください。

将来に向けて

doxygen は、すでに多くの人々によってうまく使われていますが、改良の余地というのは常にあるものです。そこで作者は、可能な、かつ/または、要求のある拡張についての、 todo/wish リストをまとめています。

謝辞

Thanks go to:

Malte Zöckler and Roland Wunderling, authors of DOC++. The first version of doxygen borrowed some code of an old version of DOC++. Although I have rewritten practically all code since then, DOC++ has still given me a good start in writing doxygen.
All people at Troll Tech, for creating a beautiful GUI Toolkit (which is very useful as a Windows/Unix platform abstraction layer :-)
My brother Frank for rendering the logos.
Harm van der Heijden for adding HTML help support.
Wouter Slegers for registering the www.doxygen.org domain.
Parker Waerchter for adding the RTF output generator.
Joerg Baumann, for adding conditional documentation blocks, PDF links, and the configuration generator.
Matthias Andree for providing a .spec script for building rpms from the sources.
Tim Mensch for adding the todo command.
Ken Wong for providing the HTML tree view code.
Jens Breitenstein, Christophe Bordeaux, Samuel Hägglund, Xet Erixon, Vlastimil Havran, Petr Prikryl, Ahmed Also Faisal, Alessandro Falappa, Kenji Nagamatsu, Francisco Oltra Thennet, Olli Korhonen, Boris Bralo, Nickolay Semyonov, Richard Kim, Földvái György, Grzegorz Kowal, and Wang Weihan for providing translations into various languages.
Erik Jan Lingen of Habanera for donating money.
The Comms group of Symbian for donating an ultra cool Revo plus organizer!
The band Porcupine Tree for providing hours of great music to listen to while coding.
many, many others for suggestions, patches and bug reports.

Doxygen manualに対してThu Dec 20 11:07:24 2001に生成されました。