Vdldoc Maven Plugin – Vdldoc Example for Includes and Excludes

Specifying taglib files via includes and excludes

Vdldoc Plugin searches the current project for JSF taglib-files. This search can be influenced via includes and excludes patterns.

Inclusions

By default the Vdldoc Plugin will include all taglib descriptor files that match the pattern **/*.taglib.xml.

If your taglib descriptor is named differently, configure Vdldoc Plugin and specify the files you want to include.

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>com.github.matinh.vdldoc</groupId>
        <artifactId>vdldoc-maven-plugin</artifactId>
        <version>2.1</version>
        <configuration>
          <includes>
            <include>some-taglib.xml</include>
            <include>**/other.taglib</include>
          </includes>
        </configuration>
      </plugin>
    </plugins>
  </reporting>
  ...
</project>

Excludes

To exclude certain taglib descriptors from being processed, specify a suitable pattern via the excludes property of the plugin. The default excludes is target/**.

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>com.github.matinh.vdldoc</groupId>
        <artifactId>vdldoc-maven-plugin</artifactId>
        <version>2.1</version>
        <configuration>
          <excludes>
            <exlude>invalid.taglib.xml</include>
            <exclude>**/not-processed/**</include>
          </excludes>
        </configuration>
      </plugin>
    </plugins>
  </reporting>
  ...
</project>