Connexions Javadoc

org.eclipse.pde.core.javadoc

3.2

Ce point d'extension associe des plug-ins à l'emplacement javadoc du code qu'ils contiennent. PDE utilise ces associations pour connecter automatiquement javadoc aux bibliothèques de plug-ins lorsqu'il calcul le chemin de classes d'un plug-in.

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


Voici un exemple d'extension 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>

Dans cet exemple, le javadoc de deux plug-ins com.example.abc etcom.example.xyz se trouve dans un répertoire references/api/ dans un fichier ZIP doc.zip dans le plug-in déclarant cette extension. Le javadoc du plug-in com.example.ghi se trouve à l'adresse http://www.sample-url.org/doc/. Le javadoc du plug-in com.example.jkl se trouve dans le répertoire doc qui est relatif à l'emplacement du plug-in déclarant cette extension.

Aucun code Java n'est requis pour ce point d'extension.

SDK Eclipse est fourni avec des plug-ins de documentation ISV utilisent ce point d'extension.