JavaDocからAPIハンドブックへ - DocBook Doclet 0.70.1~JDK 1.5.0対応に

    後藤大地  [2005/10/17]

    14日(現地時間)、The DocBook Doclet(dbdoclet)の最新版となるThe DocBook Doclet(dbdoclet) version 0.70.1が公開された。The DocBook Doclet(dbdoclet) version 0.70.1では細かい修正や改良が行われている。The DocBook Doclet(dbdoclet) version 0.70.1はJavaソースコードドキュメンテーションからDocBook形式を生成するアプリケーション。JavaDocとして作成したJavaソースコードドキュメンテーションをAPIハンドブックとして印刷したい場合などに使うことができる。

    The DocBook Doclet (dbdoclet) version 0.70.1はJavaDocの処理系として使うこともでき、また、HTML文書をDocBook形式に変換するためのアプリケーションとしても使用することができる。GPLのもとオープンソースソフトウェアとして配布されている。

    The DocBook Doclet (dbdoclet) version 0.70.1にはdbdoclet.TiDBitという管理アプリケーションが付随している。dbdoclet.TiDBitはJFC/Swingを使ったGUIアプリケーションで、ドキュメンテーションプロジェクトの管理や、PDF文書の生成などを行うフロントエンドの役割を負う。

    dbdoclet.TiDBit 動作例

    The DocBook Doclet(dbdoclet) version 0.70.1が動作するにはJDK 1.5.0を使用する必要がある。それ以外のバージョンは今後サポートされなくなる予定。またThe DocBook Doclet(dbdoclet) version 0.70.1はグラフィックの描画にJFreeChartライブラリを使用するため、イメージの生成中にはウィンドウ環境にアクセスできる必要がある。サーバのようにウィンドウ環境を持たない環境で実行するにはjava.awt.headlessプロパティを指定するなどして実行する必要がある。

    The DocBook Doclet(dbdoclet)では日本語を含むファイルの動作も確認されている。開発の現場において成果物に対するAPIの提出が求められることは少なくない。The DocBook Doclet (dbdoclet) version 0.70.1を使用すると、そういった文書化の処理を自動化することができる。

    関連記事

    関連サイト

    新着記事

    特設サイトの情報

      人気記事

      一覧

        イチオシ記事

        新着記事

        特別企画

        マイナビニュースマガジン