Develop and Download Open Source Software

View 1.1.0 - Release Notes

category(Tag) tree

file info

category(Tag)
root
file name
mergedoc_1.1.0_-_Notes
last update
2003-11-07 22:15
type
Plain Text
editor
柏原 真二
description
1.1.0 - Release Notes
language
English
translate
======================================================================
名前: MergeDoc
種類: Java アプリケーション
動作環境: JRE 1.4 以上
ライセンス: CPL v1.0
URL: http://sourceforge.jp/projects/mergedoc/
======================================================================

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

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

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


動作確認済みの実行環境と Java ソースのバージョン

  一応動作が確認できている環境は下記のとおりです。私が確認したものと、
  使っていただいている方の情報をもとにしています。

    OS         JRE       Javaソース  Javadoc API ドキュメント
    -----------------------------------------------------------
    Win2K(SP3) 1.4.2_01  1.2.2_008   jdk1_2update-doc-ja
    Win2K(SP3) 1.4.2_01  1.3.1_03    j2sdk-1_3_0-update1-doc-ja
    Win2K(SP3) 1.4.2_01  1.4.2_01    j2sdk-1.4.0-doc-ja
    Win2K(SP4) 1.4.2_02  1.4.2_02    j2sdk-1.4.0-doc-ja
    WinXP(SP1) 1.4.2_01  1.4.2_01    j2sdk-1.4.0-doc-ja

  Servlet/JSP API は日本語化した Java ソース(Tomcat)が Ja-Jakarta
  で配布されているので MergeDoc は不要です。このファイルを Eclipse の
  該当 Jar に添付することで日本語表示されます。Eclipse のテキスト・フ
  ァイル・エンコードが EUC でない場合は事前に文字コード変換が必要です。


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

  mergedoc.zip を適当な場所に解凍してください。
  解凍後のファイルのうち、動作に必要なのは mergedoc.jar のみです。
  その他のファイルは削除しても問題ありません。


アンインストール

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


起動方法

  Windows で JAR ファイルに JRE/JDK 1.4 以上の javaw などが関連付いて
  いる場合は mergedoc.jar をダブルクリックすることで起動できます。
  それ以外の場合は以下のようなコマンドで起動してください。

    java -jar mergedoc.jar

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


  起動オプション

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

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

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

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

      C:\j2sdk1.3\docs\


操作方法

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

    各項目の説明

     - Javadoc API 参照ディレクトリ

         日本語 Javadoc 標準 API ドキュメントを格納しているディレクト
         リを指定。package-list ファイルがあるディレクトリです。
         例)C:\j2sdk1.3\docs\ja\api

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

         Java 標準 API ソースアーカイブファイルを指定。
         例)C:\j2sdk1.3\src.jar

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

         ソースを出力する新しいアーカイブファイルを指定。
         例)C:\j2sdk1.3\srcja.zip

     - 出力エンコーディング

         出力時の文字エンコーディングを指定。
         デフォルトを指定した場合はプラットフォームのデフォルトエンコ
         ーディングが使用されます。Eclipse で使用する場合は Eclipse
         のテキスト・ファイル・エンコードに合わせてください。

     - ユーザ定義フィルタディレクトリ

         出力をカスタマイズする場合のユーザ定義フィルタを格納したディ
         レクトリ。必要がなければ特に指定する必要はありません。
         詳細は .\filter\touchme.txt 参照。


Eclipse の設定

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

  ホバー表示したときに枠内にコメントが収まらない場合は F2 で固定表示し
  枠を広げることが可能です。
SourceForge.JP is a Japanese version of SourceForge.net. For developments that are not related to Japan, we recommend you to use SourceForge.net.