Javadoc-liitokset

Tunniste:
org.eclipse.pde.core.javadoc

Alkaen versiosta:
3.2

Kuvaus:
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.

Merkintärakenne:

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

>


Esimerkkejä:
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.def javadoc-tiedostot sijaitsevat hakemistossa references/api/, 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.

API-tiedot:
Tähän laajennuspisteeseen ei tarvita Java-koodia.

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


Copyright (c) 2005 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html.