« マーカーレゾリューション | トップページ | 型の発見方法 »

2004.03.05

APIリファレンスの抜き出し方法

EclipseのプラットフォームやJDTのAPIリファレンスは,HelpメニューのHelp Contentsから閲覧することができる。しかし,やっぱりAPIリファレンスの類は,普通にWebブラウザでいつでも閲覧できる状態にしておきたいものである。

Eclipseはプラグインの集合体であるので,Help Contentsで閲覧できるドキュメントはプラグインが提供してくれているものだと想像できる。実際そのとおりで,オンラインヘルプ用の拡張ポイントがあり,各種プラグインはその拡張ポイントを利用してオンラインドキュメントを提供している(オンラインヘルプの作成方法については,わかり次第紹介する予定)。オンラインドキュメントのファイル群は,docsディレクトリに配置するか,docsディレクトリを圧縮したdocs.zipというファイルに配置するかのいずれかである。

プラグインを開発するにあたり,最も頻繁に閲覧するものは,プラットフォームのAPIリファレンスと,JDTのAPIリファレンスだろう。これらのAPIリファレンスは,それぞれ以下のファイルに格納されている。

 ・プラットフォームのAPIリファレンス
    $ECLIPSE_HOME/plugins/org.eclipse.platform.doc.isv_2.1.0/docs.zip
    ZIPファイル内: /reference/api

 ・JDTのAPIリファレンス
    $ECLIPSE_HOME/plugins/org.eclipse.jdt.doc.isv_2.1.0/docs.zip
    ZIPファイル内: /reference/api

各ZIPファイルから,/reference/api以下を任意のディレクトリに展開すれば,その中にあるindex.htmlを閲覧することによって,各APIリファレンスをHelp Contentsを使わずに,Webで閲覧することができるようになる。

|

« マーカーレゾリューション | トップページ | 型の発見方法 »

コメント

コメントを書く



(ウェブ上には掲載しません)




トラックバック

この記事のトラックバックURL:
http://app.cocolog-nifty.com/t/trackback/12631/265383

この記事へのトラックバック一覧です: APIリファレンスの抜き出し方法:

« マーカーレゾリューション | トップページ | 型の発見方法 »