Plugin Documentation

Goals available for this plugin:

Goal Description
plexus-component-metadata:generate-metadata Generates a Plexus components.xml component descriptor file from source (javadoc) or class annotations and manually crafted descriptor files.
plexus-component-metadata:generate-test-metadata Generates a Plexus components.xml component descriptor file from test source (javadoc) or test class annotations and manually crafted descriptor files.
plexus-component-metadata:help Display help information on plexus-component-metadata.
Call mvn plexus-component-metadata:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
plexus-component-metadata:merge-metadata Merges a set of Plexus descriptors into one descriptor file.

System Requirements

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

Maven 2.0
JDK 8

Usage

You should specify the version in your project's plugin configuration:

  1. <project>
  2. ...
  3. <build>
  4. <!-- To define the plugin version in your parent POM -->
  5. <pluginManagement>
  6. <plugins>
  7. <plugin>
  8. <groupId>org.codehaus.plexus</groupId>
  9. <artifactId>plexus-component-metadata</artifactId>
  10. <version>2.2.0-SNAPSHOT</version>
  11. </plugin>
  12. ...
  13. </plugins>
  14. </pluginManagement>
  15. <!-- To use the plugin goals in your POM or parent POM -->
  16. <plugins>
  17. <plugin>
  18. <groupId>org.codehaus.plexus</groupId>
  19. <artifactId>plexus-component-metadata</artifactId>
  20. </plugin>
  21. ...
  22. </plugins>
  23. </build>
  24. ...
  25. </project>

For more information, see "Guide to Configuring Plug-ins"