Javadoc-tilknytninger

org.eclipse.pde.core.javadoc

3.2

Udvidelsespunktet tilknytter plugins til Javadoc-placeringen for den kode, de indeholder. PDE bruger disse tilknytninger vha. mapping til automatisk at tilknytte Javadoc til plugin-biblioteker, når en plugins classpath beregnes.

<!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>


Følgende er et eksempel på javadoc-udvidelsen:
 

<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>

I eksemplet er Javadoc for to plugins, com.example.abc og com.example.xyz, placeret i biblioteket references/api/ i ZIP-filen doc.zip i den plugin, der erklærer udvidelsen. Javadoc til plugin'en com.example.ghi er placeret på http://www.sample-url.org/doc/. Javadoc til plugin'en com.example.jkl er placeret i biblioteket doc, der er relativt i forhold til placeringen af den plugin, der erklærer udvidelsen.

Der kræves ingen Java-kode til dette udvidelsespunkt.

Eclipse SDK leveres med ISV-dokumentations-plugins, der bruger udvidelsespunktet.