doxygen
Version: 1.2.11.1

Doxygen ライセンス

Copyright © 1997-2001 by Dimitri van Heesch.
Copyright © 2001 by OKA Toshiyuki (日本語訳)

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通りの方法であなたを補助します:

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

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

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

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

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

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

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

将来に向けて

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

謝辞

Thanks go to:
Doxygen manualに対してThu Dec 20 11:07:24 2001に生成されました。 doxygen1.2.11.1 の開発者: Dimitri van Heesch, © 1997-2001