Javadoc 添付

org.eclipse.pde.core.javadoc

3.2

この拡張ポイントは、プラグインを、そのプラグインが含むコードの Javadoc ロケーションと関連付けます。 PDE はこれらのマッピングを使用して、プラグインのクラスパスを計算しているときに、プラグイン・ライブラリーに javadoc を自動的に接続します。

<!ELEMENT extension (javadoc+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT javadoc (plugin+)>

<!ATTLIST javadoc

path    CDATA #REQUIRED

archive (true | false) "false">


<!ELEMENT plugin EMPTY>

<!ATTLIST plugin

id CDATA #REQUIRED>


次に示すのは、javadoc 拡張の例です。
 

<extension point=

"org.eclipse.pde.core.javadoc"

>

<javadoc path=

"doc.zip!/references/api/"

archive=

"true"

/>

<plugin id=

"com.example.abc"

/>

<plugin id=

"com.example.def"

/>

</javadoc>

<javadoc path=

"http://www.sample-url.org/doc/"

/>

<plugin id=

"com.example.ghi"

/>

</javadoc>

<javadoc path=

"doc/"

/>

<plugin id=

"com.example.jkl"

/>

</javadoc>

</extension>

この例では、2 つのプラグイン com.example.abc および com.example.xyz のための javadoc は、references/api/ ディレクトリーにある、この拡張を宣言するプラグインの doc.zip ZIP ファイル内にあります。 プラグイン com.example.ghi のための javadoc は、http://www.sample-url.org/doc/ にあります。 プラグイン com.example.jkl のための javadoc は、この拡張を宣言するプラグインのロケーションと関連するディレクトリー doc 内にあります。

この拡張ポイントには、Java コードは必要ありません。

Eclipse SDK には、この拡張ポイントを使用する ISV 文書プラグインが付属しています。