Plugin Documentation
This report describes goals, parameters details, requirements and sample usage of this plugin.
Goals
Goals available for this plugin:
Goal | Description |
---|---|
tycho-document-bundle:build-help-index | A Mojo to pre-build search help index for a plug-in. |
tycho-document-bundle:configure-document-bundle-plugin | This mojo is only there |
tycho-document-bundle:javadoc | Create the javadoc based API reference for this bundle.
This mojo creates the javadoc documentation by calling the javadoc application from the command line. In addition it creates a ready to include toc-xml file for the Eclipse Help system. The sources for creating the javadoc are generated automatically based on the dependency that this project has. As dependency you can specify any other maven project, for example the feature project that references you other bundles. Included features will be added to the list. The javadoc executable path is determined in this order:
|
tycho-document-bundle:schema-to-html | This mojo provides the functionality of org.eclipse.pde.internal.core.ant.ConvertSchemaToHTML |
System Requirements
The following specifies the minimum requirements to run this Maven plugin:
Maven | 3.9.0 |
JDK | 17 |
System Requirements History
The following specifies the minimum requirements to run this Maven plugin for historical versions:
Plugin Version | Maven | JDK |
---|---|---|
from 4.0.0 to 4.0.9 | 3.9.0 | 17 |
from 3.0.0 to 3.0.5 | - | 17 |
from 2.0.0 to 2.7.5 | - | 11 |
from 1.1.0 to 1.7.0 | - | 8 |
from 0.23.0 to 1.0.0 | - | 7 |
0.22.0 | - | 6 |
from 0.20.0 to 0.21.0 | - | 5 |
Usage
You should specify the version in your project's plugin configuration:
<project>
...
<build>
<!-- To define the plugin version in your parent POM -->
<pluginManagement>
<plugins>
<plugin>
<groupId>org.eclipse.tycho.extras</groupId>
<artifactId>tycho-document-bundle-plugin</artifactId>
<version>4.0.9</version>
</plugin>
...
</plugins>
</pluginManagement>
<!-- To use the plugin goals in your POM or parent POM -->
<plugins>
<plugin>
<groupId>org.eclipse.tycho.extras</groupId>
<artifactId>tycho-document-bundle-plugin</artifactId>
</plugin>
...
</plugins>
</build>
...
</project>
For more information, see "Guide to Configuring Plug-ins"