Doxygen

Doxygen

開発元	Dimitri van Heesch
最新版	1.7.4 / 2011年3月30日
対応OS	GNU/Linux、Windows、Mac OS X、Solaris
種別	ドキュメンテーションジェネレータ
ライセンス	GNU General Public License
公式サイト	http://www.doxygen.org/

Doxygen（ドキシジェン）は、C++、C言語、Java、Objective-C、Python、IDL（CORBAおよびマイクロソフト形式）のためのドキュメンテーションジェネレータである。他にも PHP、C#、D言語、ActionScript でもある程度利用可能。多くのUNIX系システム、Microsoft Windows、Mac OS X で動作する。Doxygen のコードの大部分は Dimitri van Heesch が書いた。

KDE は文書の一部に Doxygen を利用しており、KDevelop は組み込みでサポートしている。

概要

Javadocのように、Doxygen はソースファイルのコメントから文書を抜き出す。Javadoc の文法に加えて、Qtツールキットで使われるドキュメンテーションタグをサポートしており、HTML形式だけでなく、CHM、RTF、PDF、LaTeX、PostScript、manページ形式の文書を生成できる。

コード例

以下のコード例は、Doxygen で文書生成可能な形式である。

/**
 * The time class represents a moment of time.
 *
 * \author John Doe
 */
class Time {

  /**
   * Constructor that sets the time to a given value.
   * \param timemillis is a number of milliseconds passed since Jan 1. 1970
   */
  Time(int timemillis) {
    ...
  }

  /**
   * Get the current time.
   * \return A time object set to the current time.
   */
  static Time now() {
    ...
  }
};

関連項目

• ソフトウェアドキュメンテーション
• Eclox : Eclipse 向けの Doxygen フロントエンドフリーソフトウェアプラグイン。GNU General Public Licenseでライセンスされている。
• Graphviz : Doxygen は C++、Java、Python などについてクラス階層図などを GraphViz と連携して生成できる。

外部リンク

• Sourceforge homepage
• MediaWiki documentation Doxygen で作成