Załączniki dokumentacji Javadoc

Identyfikator:
org.eclipse.pde.core.javadoc

Dostępne od wersji:
3.2

Opis:
Ten punkt rozszerzenia służy do tworzenia powiązań między wtyczkami a umiejscowieniem zawartego w nich kodu w dokumentacji Javadoc. Odwzorowania te są wykorzystywane w środowisku PDE do automatycznego dołączania dokumentacji Javadoc do bibliotek wtyczek podczas obliczania ścieżki klas wtyczki.

Znaczniki konfiguracji:

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

>


Przykłady:
Poniżej przedstawiono przykład rozszerzenia 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>
Na powyższym przykładzie dokumentacja Javadoc dotycząca dwóch wtyczek, tj. com.example.abc i com.example.def znajduje się w katalogu references/api/ w pliku ZIP doc.zip wtyczki zawierającej deklarację rozszerzenia. Dokumentacja Javadoc wtyczki com.example.ghi znajduje się pod adresem http://www.sample-url.org/doc/. Dokumentacja Javadoc wtyczki com.example.jkl znajduje się w katalogu doc, który określono względnie do położenia wtyczki zawierające deklarację rozszerzenia.

Informacje o interfejsie API:
Dla tego punktu rozszerzenia nie jest wymagany kod Java.

Dostarczana implementacja:
Wraz z pakietem SDK Eclipse dostarczane są wtyczki dokumentacji niezależnych producentów oprogramowania korzystających z tego punktu rozszerzenia.


Copyright (c) 2005 IBM Corporation and others.
Wszelkie prawa zastrzeżone. Program ten oraz towarzyszące mu materiały są udostępniane na warunkach licencji EPL (Eclipse Public License), wersja 1.0, dołączonej do nich i dostępnej pod adresem http://www.eclipse.org/legal/epl-v10.html.