Javadoc Attachments

Identifier:
org.eclipse.pde.core.javadoc

Since:
3.2

Description:
This extension point associates plug-ins with the javadoc location of the code they contain. PDE uses these mappings to automatically attach javadoc to plug-in libraries when it computes a plug-in's classpath.

Configuration Markup:

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

>


Examples:
The following is an example of the javadoc extension:

 <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>
In this example, the javadoc for two plug-ins: com.example.abc and com.example.def have their javadoc located in a references/api/ directory inside a doc.zip ZIP file in the plug-in declaring this extension. The javadoc for plug-in com.example.ghi is located at http://www.sample-url.org/doc/. The javadoc for plug-in com.example.jkl is located in directory doc relative to the location of the plug-in declaring this extension.

API Information:
No Java code is requied for this extension point.

Supplied Implementation:
Eclipse SDK comes with ISV documentation plug-ins that use this extension point.


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.