Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[platform-releng-dev] New plug-ins and Javadoc attachments

In the Eclipse SDK, javadoc for Eclipse APIs are shipped in three
documentation plug-ins:
      1. org.eclipse.platform.doc.isv contains javadoc for the Platform
plug-ins
      2. org.eclipse.jdt.doc.isv contains javadoc for the JDT plug-ins
      3. org.eclipse.pde.doc.user contains javadoc for the PDE plug-ins

As of 3.2M1, PDE introduced the org.eclipse.pde.core.javadoc extension
point to map plug-ins to javadoc locations.
As a result, you now get javadoc attachment to libraries for free via the
PDE container on plug-in projects.

Since 3.2M1, we have seen an increase in the number of plug-ins in the SDK,
so please keep the following in mind:

1. If your plug-in was born post-3.2M1 and it contributes API, eg. the
Runtime/Equinox quintuplets, org.eclipse.core.filesytem,
org.eclipse,ui.navigator, etc.
  please go to your local documentation plug-in as described above and
update the org.eclipse.pde.core.javadoc extension to include your new
plug-ins

2. If your plug-in was born post-3.2M1 and it does not contribute API, then
no action is necessary.

3. If your plug-in existed pre-3.2M1, then no action is necessary.  All
plug-ins in this category have already been accounted for in the
appropriate documentation plug-in.


Wassim.



Back to the top