Anexos Javadoc

Identificador:
org.eclipse.pde.core.javadoc

Desde:
3.2

Descrição:
Este ponto de extensão associa plug-ins à localização javadoc do código que estes contêm. A PDE utiliza estas correlações para anexar o javadoc automaticamente às bibliotecas de plug-ins, quando calcula o caminho de classe de um plug-in.

Marcação de 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:
De seguida é apresentado um exemplo de uma 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 de dois plug-ins: com.example.abc e com.example.def têm os respectivos javadoc num directório references/api/ dentro de um ficheiro ZIP doc.zip no plug-in que declara esta extensão. O javadoc para o plug-in com.example.ghi está localizado em http://www.sample-url.org/doc/. O javadoc para o plug-in com.example.jkl está localizado num directório doc relativo à localização do plug-in que declara esta extensão.

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

Implementação fornecida:
O Eclipse SDK vem com plug-ins de documentação ISV que utilizam este ponto de extensão.


Copyright (c) 2005 IBM Corporation e outros.
Todos os direitos reservados. Este programa e os materiais que o acompanham estão disponíveis sob os termos da Eclipse Public License v1.0, que acompanha esta distribuição e está disponível em http://www.eclipse.org/legal/epl-v10.html.