Vdldoc Maven Plugin – Plugin Documentation

Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal	Report?	Description
vdldoc:help	No	Display help information on vdldoc-maven-plugin. Call `mvn vdldoc:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
vdldoc:vdldoc	Yes	Generate documentation for JSF tag libraries via OmniFaces Vdldoc.

System Requirements

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

Maven	3.6.3
JDK	11

System Requirements History

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

Plugin Version	Maven	JDK
2.1	3.6.3	11
2.0	3.3.5	6
from 1.0-alpha-1 to 1.0	3.3.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>com.github.matinh.vdldoc</groupId>
          <artifactId>vdldoc-maven-plugin</artifactId>
          <version>2.1</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>com.github.matinh.vdldoc</groupId>
        <artifactId>vdldoc-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
  <!-- To use the report goals in your POM or parent POM -->
  <reporting>
    <plugins>
      <plugin>
        <groupId>com.github.matinh.vdldoc</groupId>
        <artifactId>vdldoc-maven-plugin</artifactId>
        <version>2.1</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

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