Javadoc-bilagor

ID:
org.eclipse.pde.core.javadoc

Sedan:
3.2

Beskrivning:
Utökningspunkten associerar insticksprogram med javadoc-platsen för den kod de innehåller. PDE använder de här avbildningarna till att automatiskt bifoga javadoc till bibliotek för insticksprogram vid beräkning av klassökvägen för ett insticksprogram.

Konfigurationsmärkord:

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

>


Exempel:
Följande är ett exempel på utökningen 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>
I exemplet har javadoc för två insticksprogram: com.example.abc och com.example.def sin javadoc i en katalog med namnet references/api/ i zipfilen doc.zip i det insticksprogram som deklarerar utökningen. Javadoc för insticksprogrammet com.example.ghi finns på http://www.sample-url.org/doc/. Javadoc för insticksprogrammet com.example.jkl finns i katalogen doc relativ platsen för det insticksprogram som deklarerar utökningen.

API-information:
Ingen Java-kod krävs för utökningspunkten.

Medföljande implementation:
Eclipse SDK levereras med ISV-dokumentationsinsticksprogram som använder utökningspunkten.


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.