Conexões Javadoc

Identificador:
org.eclipse.pde.core.javadoc

Desde:
3.2

Descrição:
Este ponto de extensão associa plug-ins ao local javadoc do código que eles contêm. O PDE utiliza esses mapeamentos para conectar automaticamente o javadoc às bibliotecas de plug-in quando ele calcula um caminho de classe do plug-in.

Marcação da Configuração:

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

>


Exemplos:
A seguir, um exemplo da extensão 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>
Neste exemplo, o javadoc para dois plug-ins: com.example.abc e com.example.def possui seus javadocs localizados em um diretório references/api/ dentro de um arquivo ZIP doc.zip no plug-in que declara esta extensão. O javadoc para plug-in com.example.ghi está localizado em http://www.sample-url.org/doc/. O javadoc para plug-in com.example.jkl está localizado no diretório doc relativo ao local do plug-in que declara essa extensão.

Informações da API:
Nenhum código Java é necessário para este ponto de extensão.

Implementações Fornecidas:
O Eclipse SDK é fornecido com plug-ins de documentação ISV que utilizam esse ponto de extensão.


Copyright (c) 2005 IBM Corporation e outros.
Todos os direitos reservados. Este programa e os materiais fornecidos com ele são disponibilizados sob os termos do Licença Pública do Eclipse v1.0 que acompanha esta distribuição e está disponível em http://www.eclipse.org/legal/epl-v10.html.