Built by Maven

Plugin Documentation

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

  • executable argument of the javadocOptions configuration element, if available
  • active Maven toolchain
  • java.home system property
  • JAVA_HOME environment setting
  • if none of the above can be used, the javadoc executable is invoked without an explicit path and relies on the operating system PATH variable

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.9.0
JDK 17

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.1</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"