Javadoc-liitokset

org.eclipse.pde.core.javadoc

3.2

Tämä laajennuspiste liittää lisäosat sinne, missä niiden koodin javadoc sijaitsee. PDE käyttää näitä vastaavuuksia javadoc-tiedoston liittämiseksi lisäosakirjastoihin, kun se laskee lisäosien luokkapolkua.

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


Seuraavassa on esimerkki javadoc-laajennuksesta:
 

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

Tämän esimerkin kahden lisäosan com.example.abc ja com.example.xyz javadoc-tiedostot sijaitsevat hakemistossa references/api/, joka joka sijaitsee laajennuksen esittelevässä lisäosassa olevassa ZIP-tiedostossa doc.zip. Lisäosan com.example.ghi javadoc sijaitsee osoitteessa http://www.sample-url.org/doc/. Lisäosan com.example.jkl javadoc sijaitsee laajennuksen esittelevän lisäosan doc-hakemistossa.

Tähän laajennuspisteeseen ei tarvita Java-koodia.

Eclipse SDK -paketin mukana toimitetaan ISV-dokumentaatiolisäosia, jotka käyttävät tätä laajennuspistettä.