The Apache Jakarta Project Jakarta HiveMind Project
 
   

HiveDoc

HiveMind には、HiveMind レジストリ(ランタイム時にデプロイされた全てのモジュールからの情報がセットになったもの)を文書化する為のツールが含まれています。ビルド時に、全ての関連したHiveMindモジュールのデプロイ記述子が解析され、その結果が結合されて一つのファイルに纏められます。次に、マスターファイル(このドキュメントにのみ使われるもの)がXSLTを通じてHTMLファイルのセットへと変換されます。最終成果物はJavaDocにとてもよく似ており、全てハイパーリンクがつけられ、全てのサービス・設定ポイント・コントリビューション・そしてスキーマが明白に分かるようになるでしょう。

生成されるドキュメントに結合されるのは、ユーザが指定した説明です。 <attribute>, <configuration-point>, <element>, <module>, <schema> 及び <service-point> 要素には、文字列データの説明を入れる事が出来ます。例えば:

<module id="mymodule" version="1.0.0">
  A module for my application with my services, etc.
</module>

HiveMind フレームワーク及びライブラリ用の HiveDoc はこちらで手に入ります。

Warning
ドキュメントのビルドに関する詳細はまた改めて。