#author("2021-12-14T01:52:49+00:00","","")
#author("2021-12-14T02:33:22+00:00","","")
#topicpath
----
//ここにコンテンツを記述します。


*API Document 検索 for Java [#mb53e628]

#contents

**API Document 検索 とは? [#x4411ed9]
>ローカルやインターネットのJavaDocからクラス名を検索し、そのクラスのJavaDoc, Java2html,CVSリポジトリをブラウザで表示するプログラムです。趣味で作成しましたが、わりと便利。API Document 検索 はMasatomi KINOによって書かれました。


**ディレクトリ構成 [#k662a2d4]
 [JavaDocSearch]
  |-javadocsearch.exe               - メインのEXE (Windows用)
  |-javadocsearch.bat               - メインのEXE (Windows用バッチファイル)
  |-javadocsearch.sh                - メインのEXE (Unix用)
  |-mobexe.ini                      - 設定ファイル(MobExe用)
  |-[source]                        - ソース
  |   -[kino]..                     - Javaソース
  |-[lib]                           - ライブラリ用ディレクトリ(Windows用)
  |   -[kino_javadocsearch.jar]     - API Document 検索のjar
  |   -[kino]
  |      -[config]                  - Configファイルのディレクトリ
  |      -[log4j]                   - Log4j設定ファイルのディレクトリ
  |-[lib4u](作成してください)       - Unix用SWTライブラリのディレクトリ

**ダウンロード [#l75262bf]
-現在の最新版のダウンロード
#ref(JavaDocSearch.lzh)
-[[CVSはこちら:http://www.masatom.in/cgi-bin/viewvc.cgi/JavaDocSearch/?root=cvs]]

**インストール [#pfc0687d]
***ライブラリの解凍 [#ae0a54f1]
ダウンロードしたファイルを適当な位置に解凍します。


***SWTライブラリの配置 [#z1f2a50d]
Eclipse Tools Project (http://www.eclipse.org/platform/main.html)より、SWT Binary and Source に移動し、SWTのjarファイルをダウンロードします。
現在(2003/12/15)の最新版は
 ftp://download.eclipse.org/R-2.1.2-200311030802/swt-2.1.2-win32.zip
 ftp://download.eclipse.org/R-2.1.2-200311030802/swt-2.1.2-linux-gtk.zip
です。解凍後、~
Windows環境では
 ./swt-win32-2135.dll
 ./lib/swt.jar
Linux環境では
 ./lib4u/swt.jar
 ./lib4u/swt-pi.jar
に配置します。Linux環境では更に
 libswt-gnome-gtk-2135.so
 libswt-gtk-2135.so
 libswt-pi-gtk-2135.so
を /usr/lib にコピーします。

***HttpUnitライブラリの配置 [#m07d0632]
さらにローカルではなく、インターネット上のドキュメントを検索する場合は、HttpUnitが必要です。 http://httpunit.sourceforge.net/ より、HttpUnitのjarをダウンロードします。現在(2003/12/15)の最新版は
 http://umn.dl.sourceforge.net/sourceforge/httpunit/httpunit-1.5.4.zip
です。解凍後
 ./lib/httpunit.jar
 ./lib/Tidy.jar
 ./lib/js.jar
に配置します。

***Log4jライブラリの配置 [#i186ad05]
ログ出力のライブラリとして、Log4jを使用します。http://jakarta.apache.org/log4j/docs/index.html よりLog4jのjarをダウンロードします。現在(2003/12/15)の最新版は
 http://www.meisei-u.ac.jp/mirror/apache/dist/jakarta/log4j/binaries/jakarta-log4j-1.2.8.tar.gz
などです。解凍後
 ./lib/log4j-1.2.8.jar
に配置します。

以上でインストールは完了です。

''(2004/11/23追記)とおもってたら、jface.jarの配置を忘れてますね。lib以下に配置すればよいんですが、単体配布されていないのでEclipse2.1系を落としてきてそこから取得しないといけないですね。。''

**使い方。 [#sf3868bf]
+javadocsearch.exeをダブルクリック。~
ウィンドウが開けばOKです。
+検索したいクラス名を入力して検索ボタンをクリック~
パッケージ名だけでも検索可能です。
+一覧が下に表示されるので、参照したいクラス名をダブルクリックすると、JavaDocを表示したIEが起動します。
+ダブルクリックではなく右クリックをすることで、ショートカットメニューが現れます。~
開きたいもの(JavaDoc,Java2html,CVS)をメニューより選択すれば、開くことができます。

#ref(screenshot.png)

**APIドキュメント、ソースドキュメント [#l87ee0d1]
-[[APIドキュメント:http://www.masatom.in/document/javadocsearch/javadoc/]]
-[[ソースドキュメント:http://www.masatom.in/document/javadocsearch/j2h/]]
-[[UnitTest結果:http://www.masatom.in/document/javadocsearch/report/html/]]
-[[UnitTestカバレッジ:http://www.masatom.in/document/javadocsearch/report/clover/]]
-[[ChangeLog:http://www.masatom.in/document/javadocsearch/changelog.html]]


-[[Mavenでつくってみたサイト:http://www.masatom.in/document/JavaDocSearch_maven/]]

-[[WEBバージョンも作りました(例で自サイトのJavaDocとStrutsのJavadocのみ):http://www.masatom.in/kinoapp/index.do]]


**TODO [#ee314302]
-キャンセルを実装する。
-%%検索(検索元取得)をマルチスレッド化する%%
-検索元をキャッシュする?
-検索機能をストラテジとして切り替え可能とする
-いつの間にかローカルで稼動しなくなってるので修正する
-mavenなどでプロ管したい
-JUnitを本格的に適用したい
-Clover(コードカバレッジツール)などを適用したい
-あ、ディレクトリに日本語とかスペースがあると動かない。
-Webサービス化し、どんな検索が行われているかをウォッチする。
-いまどき、RCP化か。。



**ライセンス [#e560d969]
The Apache Software License, Version 1.1に準じます。

**謝辞 [#b60455e8]
以下のモジュールを使ってます。感謝。
-SWT(SwingよりCoolなToolKit) http://www.eclipse.org/
-MobExe(Java起動Exe) http://www.mobster.jp/wiki/index.jsp?pid=MobExe
-HttpUnit(Httpクライアント) http://httpunit.sourceforge.net/
-Log4j(ログ出力用ライブラリ)http://jakarta.apache.org/log4j/docs/index.html
-Relaxer(XMLスキーマ&コンパイラ)http://www.relaxer.org/index_ja.html
----
これは
#vote(つかえそう[20],そうでもない[5])
#vote(つかえそう[21],そうでもない[5])


#topicpath


SIZE(10){現在のアクセス:&counter;}

トップ   編集 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS