Conexiones Javadoc

Identificador:
org.eclipse.pde.core.javadoc

Desde:
3.2

Descripción:
Este punto de extensión asocia plug-ins con la ubicación javadoc del código que contienen. PDE utiliza estas correlaciones para conectar un javadoc automáticamente a bibliotecas de plug-in cuando calcula una vía de acceso de clases de plug-in.

Código de configuración:

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

>


Ejemplos:
Este es un ejemplo de la extensión 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>
En este ejemplo, javadoc para dos plug-ins, com.example.abc y com.example.def tienen los javadocs ubicados en un directorio references/api/ dentro de un archivo zip doc.zip en el plug-in que declara esta extensión. El javadoc para el plug-in com.example.ghi está ubicado en http://www.sample-url.org/doc/. El javadoc del plug-in com.example.jkl está ubicado en el directorio doc relativo a la ubicación del plug-in que declara esta extensión.

Información sobre la API:
No es necesario código Java para este punto de extensión.

Implementación suministrada:
Eclipse SDK viene con los plug-ins de documentación ISV que utilizan este punto de extensión.


Copyright (c) 2005 IBM Corporation y otras empresas.
Reservados todos los derechos. Este programa y sus materiales adjuntos están disponibles bajo los términos de la licencia pública común (Eclipse Public License) v1.0 que acompaña a esta distribución, y está disponible en http://www.eclipse.org/legal/epl-v10.html