Javadoc-Anhänge

Kennung:
org.eclipse.pde.core.javadoc

Seit:
3.2

Beschreibung:
Dieser Erweiterungspunkt ordnet Plug-ins der Javadoc-Position des Codes zu, den sie enthalten. Die PDE verwendet diese Zuordnungen, um ein Javadoc an Plug-in-Bibliotheken anzuhängen, wenn der Klassenpfad eines Plug-ins berechnet wird.

Konfigurationsbefehle:

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

>


Beispiele:
Die folgenden Angaben sind ein Beispiel für den Erweiterungspunkt 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 diesem Beispiel befindet sich das Javadoc für die zwei Plug-ins com.example.abc und com.example.def im Verzeichnis references/api/ in einer komprimierten Datei doc.zip in dem Plug-in, das diese Erweiterung deklariert. Das Javadoc für das Plug-in com.example.ghi befindet sich in http://www.sample-url.org/doc/. Das Javadoc für das Plug-in com.example.jkl befindet sich im Verzeichnis doc, abhängig von der Position des Plug-ins, das die Erweiterung deklariert.

API-Informationen:
Für diesen Erweiterungspunkt ist kein Java-Code erforderlich.

Bereitgestellte Implementierung:
Das Eclipse-SDK wird mit ISV-Dokumentations-Plug-ins ausgeliefert, die diesen Erweiterungspunkt verwenden.


Copyright (c) 2005 IBM Corporation und andere.
Alle Rechte vorbehalten. Dieses Programm und sein Begleitmaterial werden gemäß den Bedingungen der "Eclipse Public License v1.0" zur Verfügung gestellt, die dieser Lieferung beiliegt und unter http://www.eclipse.org/legal/epl-v10.html abgerufen werden kann.