Javadoc-koppelingen

org.eclipse.pde.core.javadoc

3.2

Dit extensiepunt koppelt plugins aan de Javadoc-locatie van de code die in de plugins is opgenomen. Deze toewijzingen worden door PDE gebruikt om Javadoc automatisch aan pluginbibliotheken te koppelen tijdens het berekenen van het klassenpad van een plugin.

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


Dit is een voorbeeld van de extensie 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>

In dit voorbeeld bevindt de Javadoc voor twee plugins (com.example.abc en com.example.xyz) zich in de directory references/api/ in een ZIP-bestand met de naam doc.zip in de plugin die deze extensie declareert. De Javadoc voor de plugin com.example.ghi bevindt zich op http://www.sample-url.org/doc/. De Javadoc voor de plugin com.example.jkl bevindt zich in de relatieve directory doc ten opzichte van de locatie van de plugin die deze extensie declareert.

Voor dit extensiepunt is geen Java-code nodig.

Bij de Eclipse SDK worden ISV-documentatieplugins geleverd die dit extensiepunt gebruiken.