Fork me on GitHub
Built by Maven

vdldoc:vdldoc

Note:

This goal should be used as a Maven report.

Full name:

com.github.matinh.vdldoc:vdldoc-maven-plugin:2.1:vdldoc

Description:

Generate documentation for JSF tag libraries via OmniFaces Vdldoc.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 1.0-alpha-1.
  • Binds by default to the lifecycle phase: site.
  • Invokes the execution of the following lifecycle phase prior to executing itself: generate-sources.

Optional Parameters

Name Type Since Description
<attributesFile> String 1.0 Path to properties file containing descriptions for implied attributes of composite components, such as 'id', 'rendered', etc.
User Property: maven.vdldoc.attributesFile
<browserTitle> String - Browser window title.
Default: ${project.name} VDL Documentation
<css> String 1.0 URI of the CSS file. This defaults to Vdldocs internal CSS.
User Property: maven.vdldoc.css
<destDir> String - Name of the directory (inside the reporting-output-directory) into which Vdldoc will place the generated documentation.
Default: vdldoc
User Property: maven.vdldoc.destDir
<documentTitle> String - Documentation title.
Default: ${project.name} VDL Documentation
<excludes> List<String> - Patterns to exclude when searching for taglib descriptor files.
Default: target/**
User Property: maven.vdldoc.excludes
<facesConfig> String 1.0 Path to the faces-config.xml file.
User Property: maven.vdldoc.facesConfig
<failOnError> boolean - If false, build will continue when generation of documentation fails.
Default: true
User Property: maven.vdldoc.failOnError
<hideGeneratedBy> boolean 1.0 Hide the "output generated by" footer.
Default: false
User Property: maven.vdldoc.hideGeneratedBy
<includes> List<String> - Patterns to include when searching for taglib descriptor files.
Default: **/*.taglib.xml
User Property: maven.vdldoc.includes
<reportOutputDirectory> File - Location of the output directory for the generated report. This configuration is usually only useful if you call the mojo directly from the command-line.
Default: ${project.reporting.outputDirectory}
User Property: maven.vdldoc.outputDirectory
<skip> boolean - Skip the generation of VDL documentation.
Default: false
User Property: maven.vdldoc.skip

Parameter Details

<attributesFile>

Path to properties file containing descriptions for implied attributes of composite components, such as 'id', 'rendered', etc.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: maven.vdldoc.attributesFile

<browserTitle>

Browser window title.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.name} VDL Documentation

<css>

URI of the CSS file. This defaults to Vdldocs internal CSS.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: maven.vdldoc.css

<destDir>

Name of the directory (inside the reporting-output-directory) into which Vdldoc will place the generated documentation.
  • Type: java.lang.String
  • Required: No
  • User Property: maven.vdldoc.destDir
  • Default: vdldoc

<documentTitle>

Documentation title.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.name} VDL Documentation

<excludes>

Patterns to exclude when searching for taglib descriptor files.
  • Type: java.util.List<java.lang.String>
  • Required: No
  • User Property: maven.vdldoc.excludes
  • Default: target/**

<facesConfig>

Path to the faces-config.xml file.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: maven.vdldoc.facesConfig

<failOnError>

If false, build will continue when generation of documentation fails.
  • Type: boolean
  • Required: No
  • User Property: maven.vdldoc.failOnError
  • Default: true

<hideGeneratedBy>

Hide the "output generated by" footer.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: maven.vdldoc.hideGeneratedBy
  • Default: false

<includes>

Patterns to include when searching for taglib descriptor files.
  • Type: java.util.List<java.lang.String>
  • Required: No
  • User Property: maven.vdldoc.includes
  • Default: **/*.taglib.xml

<reportOutputDirectory>

Location of the output directory for the generated report. This configuration is usually only useful if you call the mojo directly from the command-line.
  • Type: java.io.File
  • Required: No
  • User Property: maven.vdldoc.outputDirectory
  • Default: ${project.reporting.outputDirectory}

<skip>

Skip the generation of VDL documentation.
  • Type: boolean
  • Required: No
  • User Property: maven.vdldoc.skip
  • Default: false