Fork me on GitHub

vdldoc:vdldoc

Note:This goal should be used as a Maven report.

Full name:

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

Description:

Generate documentation for JSF tag libraries via OmniFaces Vdldoc.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.0-alpha-1.
  • Binds by default to the lifecycle phase: site.
  • Invokes the execution of the lifecycle phase generate-sources prior to executing itself.

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 is: maven.vdldoc.attributesFile.
browserTitle String 1.0-alpha-1 Browser window title.
Default value is: ${project.name} VDL Documentation.
css String 1.0 URI of the CSS file. This defaults to Vdldocs internal CSS.
User property is: maven.vdldoc.css.
destDir String 1.0-alpha-1 Name of the directory (inside the reporting-output-directory) into which Vdldoc will place the generated documentation.
Default value is: vdldoc.
User property is: maven.vdldoc.destDir.
documentTitle String 1.0-alpha-1 Documentation title.
Default value is: ${project.name} VDL Documentation.
excludes List 1.0-alpha-1 Patterns to exclude when searching for taglib descriptor files.
Default value is: target/**.
User property is: maven.vdldoc.excludes.
facesConfig String 1.0 Path to the faces-config.xml file.
User property is: maven.vdldoc.facesConfig.
failOnError boolean 1.0-alpha-1 If false, build will continue when generation of documentation fails.
Default value is: true.
User property is: maven.vdldoc.failOnError.
hideGeneratedBy boolean 1.0 Hide the "output generated by" footer.
Default value is: false.
User property is: maven.vdldoc.hideGeneratedBy.
includes List 1.0-alpha-1 Patterns to include when searching for taglib descriptor files.
Default value is: **/*.taglib.xml.
User property is: maven.vdldoc.includes.
reportOutputDirectory File 1.0-alpha-1 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 value is: ${project.reporting.outputDirectory}.
User property is: maven.vdldoc.outputDirectory.
skip boolean 1.0-alpha-1 Skip the generation of VDL documentation.
Default value is: false.
User property is: 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
  • Since: 1.0-alpha-1
  • 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
  • Since: 1.0-alpha-1
  • Required: No
  • User Property: maven.vdldoc.destDir
  • Default: vdldoc

documentTitle:

Documentation title.
  • Type: java.lang.String
  • Since: 1.0-alpha-1
  • Required: No
  • Default: ${project.name} VDL Documentation

excludes:

Patterns to exclude when searching for taglib descriptor files.
  • Type: java.util.List
  • Since: 1.0-alpha-1
  • 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
  • Since: 1.0-alpha-1
  • 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
  • Since: 1.0-alpha-1
  • 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
  • Since: 1.0-alpha-1
  • Required: No
  • User Property: maven.vdldoc.outputDirectory
  • Default: ${project.reporting.outputDirectory}

skip:

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