View All Attachments for Bug 52894

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Attachment #24660
javadoc extension point	text/html	2005-07-13 08:57:58 EDT	5.16 KB	no flags	Details

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Javadoc Attachments</title>
<style>@import url("file:/d:/Eclipse/eclipse/plugins/org.eclipse.sdk_3.1.0/book.css");</style>
<style>@import url("file:/d:/Eclipse/eclipse/plugins/org.eclipse.platform.doc.isv_3.1.0/schema.css");</style>
</HEAD>
<BODY>
<H1><CENTER>Javadoc Attachments</CENTER></H1>
<p></p>
<h6 class=CaptionFigColumn id=header>Identifier: </h6>org.eclipse.pde.core.javadoc<p></p>
<h6 class=CaptionFigColumn id=header>Since: </h6>3.2
<p></p>

<p>
<h6 class=CaptionFigColumn id=header>Description: </h6>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.</p>
<p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p>
<p class=code id=dtd>&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.javadoc">javadoc</a>+)&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST extension</p>
<p class=code id=dtdAttlist>point&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<ul class=ConfigMarkup id=attlistDesc>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.javadoc">javadoc</a> (<a href="#e.plugin">plugin</a>+)&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST javadoc</p>
<p class=code id=dtdAttlist>path&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>archive&nbsp;(true | false) "false"&gt;</p>
<p></p>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>path</b> - The <code>path</code> is a URL or a path that is relative to the plug-in declaring the extension.</li>
<li><b>archive</b> - an optional attribute indicating if the javadoc is located inside an archive.  If not specified, the default is <code>false</code>.  This attribute should be used only if the <code>path</code> attribute specifies a relative path.  This attribute has no effect if the <code>path</code> attribute specifies a URL.</li>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.plugin">plugin</a> EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST plugin</p>
<p class=code id=dtdAttlist>id&nbsp;CDATA #REQUIRED&gt;</p>
<p></p>
<ul class=ConfigMarkup id=attlistDesc>
<li><b>id</b> - the id of the plug-in whose javadoc location is specified by the <code>path</code> attribute</li>
</ul>
<br><h6 class=CaptionFigColumn id=header>Examples: </h6>The following is an example of the <code>javadoc</code> extension:
<pre>
 <p class=code id=tag>&lt;extension point=<p class=code id=cstring>&quot;org.eclipse.pde.core.javadoc&quot;</p><p class=code id=tag>&gt;</p>
     <p class=code id=tag>&lt;javadoc path=<p class=code id=cstring>&quot;doc.zip!/references/api/&quot;</p><p class=code id=tag> archive=<p class=code id=cstring>&quot;true&quot;</p><p class=code id=tag>/&gt;</p>
        <p class=code id=tag>&lt;plugin id=<p class=code id=cstring>&quot;com.example.abc&quot;</p><p class=code id=tag>/&gt;</p>
        <p class=code id=tag>&lt;plugin id=<p class=code id=cstring>&quot;com.example.def&quot;</p><p class=code id=tag>/&gt;</p>
     <p class=code id=tag>&lt;/javadoc&gt;</p>
     
     <p class=code id=tag>&lt;javadoc path=<p class=code id=cstring>&quot;http://www.sample-url.org/doc/&quot;</p><p class=code id=tag>/&gt;</p>
        <p class=code id=tag>&lt;plugin id=<p class=code id=cstring>&quot;com.example.ghi&quot;</p><p class=code id=tag>/&gt;</p>
     <p class=code id=tag>&lt;/javadoc&gt;</p>
     
     <p class=code id=tag>&lt;javadoc path=<p class=code id=cstring>&quot;doc/&quot;</p><p class=code id=tag>/&gt;</p>
        <p class=code id=tag>&lt;plugin id=<p class=code id=cstring>&quot;com.example.jkl&quot;</p><p class=code id=tag>/&gt;</p>
     <p class=code id=tag>&lt;/javadoc&gt;</p>     
  <p class=code id=tag>&lt;/extension&gt;</p>
</pre>

In this example, the javadoc for two plug-ins: <code>com.example.abc</code> and <code>com.example.xyz</code> have their javadoc located in a <code>references/api/</code> directory inside a <code>doc.zip</code> ZIP file in the plug-in declaring this extension.

The javadoc for plug-in <code>com.example.ghi</code> is located at <code>http://www.sample-url.org/doc/</code>.

The javadoc for plug-in <code>com.example.jkl</code> is located in directory <code>doc</code> relative to the location of the plug-in declaring this extension.
<p></p>

<h6 class=CaptionFigColumn id=header>API Information: </h6>No Java code is requied for this extension point.
<p></p>

<h6 class=CaptionFigColumn id=header>Supplied Implementation: </h6>Eclipse SDK comes with ISV documentation plug-ins that use this extension point.
<p></p>

<br>
<p class=note id=copyright>
Copyright (c) 2005 IBM Corporation and others.
<br>
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 
<a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.
<p></p>

</p>
</BODY>
</HTML>