Develop and Download Open Source Software

Release Note (MergeDoc for javadoc 1.4 - 1.2.8)

================================================================================
名前: MergeDoc
種類: Java アプリケーション
動作環境: JRE 1.4 以上
ライセンス: CPL v1.0
URL： http://sourceforge.jp/projects/mergedoc/
================================================================================

Eclipse は日本語化しても Java 標準 API のメソッドなどにマウスを合わせたときにホ
バー表示される説明は日本語化されません。これは Eclipse が JDK 付属の Java ソース
から Javadoc コメントを取得し表示しているためです。MergeDoc は日本語のホバー表示
を可能にするために Java ソースと日本語 API ドキュメントをマージするツールです。

またホバー表示以外にも次のような場合に参照するソースもコメントが日本語になります。

- Java 標準 API のメソッドを Ctrl + 左クリック
- Java 標準 API の例外スタックトレースからジャンプ
- パッケージエクスプローラから rt.jar を辿ってクラスファイルを開く


動作確認されている実行環境

OS JRE のバージョン
-----------------------------------
Windows2000 SP3 1.4.2_01
Windows2000 SP4 1.4.1_06
Windows2000 SP4 1.4.2_03
WindowsXP SP1 1.4.2_01
Linux FedoraCore1 1.4.2


動作確認されているマージ対象の Java ソースと API ドキュメント

Java ソース API ドキュメント
-----------------------------------------------------------------------
J2SE1.2.2_008 src.jar jdk1_2update-doc-ja.zip
J2SE1.3.1_03 src.jar j2sdk-1_3_0-update1-doc-ja.zip
J2SE1.4.2_03 src.zip j2sdk-1.4.0-doc-ja.zip
jakarta-servletapi-4-src-20031212.zip j2sdkee-1_3_1-doc-ja-apidocs.zip
jboss-3.2.3-src.tar.gz j2sdkee-1_3_1-doc-ja-apidocs.zip
RoboCode1.0.6 robocode.jar robocode_api.zip


Struts の API は Ja-Jakarta（http://www.jajakarta.org/）の有志の方々により日本
語訳されたソースが配布されています。またこれらの Eclipse での利用方法について
は同 Ja-Jakarta のメンバでもある「あめのこやね（http://www.koyane.org/）」さん
のサイトで詳しく解説されていますので、そちらをご参照ください。

その他のものでも日本語 API ドキュメントが配布されている場合は MergeDoc でマー
ジ出来るかもしれません。出来たとか、問題ありなどフォーラムなどでお知らせいただ
ければ幸いです。



================================================================================
インストール

mergedoc.zip を適当な場所に解凍してください。
以前のバージョンがある場合は置換定義ファイルを上書きしてしまうのでカスタマイズ
している場合は事前に退避してください。



アンインストール

ディレクトリごと削除してください。



起動方法

Windows で JAR ファイルに JRE/JDK 1.4 以上の javaw を関連付けている場合は
mergedoc.jar ダブルクリックで起動します。また mergedoc.jar のショートカットで
も起動出来ます（ショートカット用のアイコンは \conf\icon.ico）。

それ以外の場合は次のコマンドで起動してください。

java -jar mergedoc.jar

mergedoc.bat は Windows 用のサンプル起動ファイルです。必要に応じてエディタなど
で JAVA_HOME を編集してください。


起動オプション

-Dtarget.directory=ディレクトリ名

ターゲットディレクトリに入力ソースアーカイブファイルがある有効なディレクト
リを指定することで設定画面にデフォルトのファイル名が初期値としてセットされ
ます。

例）java -jar -Dtarget.directory=C:\j2sdk1.3 mergedoc.jar

Javadoc API ドキュメントは JDK インストールディレクトリ内に配置しておくこ
とをお勧めします。このオプションにより API ドキュメントディレクトリも検出
されます。また、このオプションを指定しなかった場合でも、Javadoc API 参照デ
ィレクトリ設定時に入出力アーカイブファイルが自動で検出されます。

例）C:\j2sdk1.3\docs\ja\api\



操作方法

起動後の設定画面で設定を行い実行ボタンを押下してください。

基本設定


* API ドキュメントディレクトリ

日本語 Javadoc 標準 API ドキュメントを格納しているディレクトリを指定。
package-list ファイルがあるディレクトリです。

例）C:\j2sdk1.3\docs\ja\api

エンコーディングは JDK の場合は ISO-2022-JP にしてください。


* 入力ソースアーカイブファイル

Java 標準 API ソースアーカイブファイルを指定。
ファイル形式は「.zip」「.jar」「.tar.gz」のいずれか。ただし .tar.gz を
使用する場合は ant.jar を mergedoc.jar と同じ場所に配置してください。

例）C:\j2sdk1.3\src.jar

エンコーディングは JDK の場合、ASCII 以外の文字が含まれていないので
何でも OK です。


* 出力ソースアーカイブファイル

ソースを出力する新しいアーカイブファイルを指定。
ファイル形式は「.zip」「.jar」のいずれか。

例）C:\j2sdk1.3\srcja.zip

エンコーディングは使用するエディタや IDE に合わせてください。Eclipse の
場合はテキスト・ファイル・エンコードと同じにしてください。またプロジェ
クトによってエンコードが異なる場合は srcja_MS932.zip、srcja_EUC-JP.zip
などのように複数のファイルを作成しておくと良いと思います。



詳細設定

出力ソースの調整を行います。設定をカスタマイズする場合は conf ディレクト
リの global.xml を参照してください。


API ドキュメントディレクトリを省略して実行することで Java ソースファイルの文字
コードの変換のみを行うことが可能です。その場合でも詳細設定は適用されます。なお
その他のファイルは文字コード変換も詳細設定も適用せずそのまま出力します。

例えばマージ済みの srcja_EUC-JP.zip を元に srcja_MS932.zip を作成することが出
来ます。マージに比べ、コード変換のみのほうがかなり高速です。



Eclipse で使用する場合の設定

Eclipse のパッケージエクスプローラから JRE システム・ライブラリー内の rt.jar
を右クリックしてプロパティを開き Java ソースの添付でロケーションパスに MergeDoc
で作成した出力ソースアーカイブファイルを指定してください。

ホバー表示したときに枠内にコメントが収まらない場合は F2 で固定表示し枠を広げる
ことが可能です。



謝辞

Eclipse wiki の方々にたくさんの助言をいただきました。感謝いたします。

- http://www.eclipsewiki.net/eclipse/
- http://www.eclipsewiki.net/eclipse/index.php?日本語でホバー表示

Show files in this release