The reference guide section of the Platform ISV documentation is generated at build time based on content supplied by component owners. It is important that component owners supply the required reference doc in the proper location for all public API.
If your component defines an extension point, you should supply a complete definition of the extension point for the reference documentation. These are supplied as HTML files which are copied to the org.eclipse.platform.isv.doc plug-in at build time.
Extension point definitions are copied from a "doc" subdirectory located directly underneath your plug-in's directory in the repository. For example, the workbench extension point documentation is located in
/home/eclipse/org.eclipse.ui/doc
The "doc" subdirectory should only be used for extension point definitions. If you have not supplied extension point definitions in previous builds but need to contribute them, contact Dean Roberts to ensure that your component's doc directory is added to the script that builds the reference material.
Here is the extension point document for org.eclipse.ui.popupMenus.
If you ship example plug-ins, you should be providing a summary document for each example provided. This should be an HTML file that describes the purpose of the example and gives the user enough information to run the example and start looking at the source code. The example doc files are copied to the org.eclipse.platform.isv.doc plug-in at build time.
Example summaries are copied from a "doc-html" subdirectory located directly underneath your example plug-in's directory in the repository. For example, the SWT examples doc is located in
/home/eclipse/org.eclipse.swt.examples/doc-html /home/eclipse/org.eclipse.swt.examples.controls/doc-html /home/eclipse/org.eclipse.swt.examples.launcher/doc-html ...
The "doc-html" subdirectory should only be used for extension point definitions. If you have not supplied extension point definitions in previous builds but need to contribute them, contact Dean Roberts to ensure that your component's example doc-html directory is added to the script that builds the reference material.
Here is the example doc for the SWT Text Editor.
Some components have specific reference documentation needs. For example, the core component contributes many reference documents, such as the component manifest file format, Eclipse command-line arguments, etc.
If you need to contribute specialized reference material, contact Susan Franklin to ensure that this material gets added to the ISV doc plug-in. If you have commit rights to org.eclipse.platform.doc.isv, you may commit the material to
/home/eclipse/org.eclipse.swt.examples/doc-html
You will still need to contact Susan so that the file can be reviewed and the XML table of contents can be updated to include your new doc.
Javadoc is generated at build time based on a list of packages in
/home/eclipse/org.eclipse.platform.doc.isv/platformOptions.txt
If you need to add or delete a package from the javadoc, contact Dean Roberts to ensure the platformOptions file is updated and the XML table of contents is corrected.