Fork me on GitHub
Built by Maven

taglib:taglibdoc

Note:

This goal should be used as a Maven report.

Full name:

io.github.weblegacy:taglib-maven-plugin:3.0.0-SNAPSHOT:taglibdoc

Description:

Generates taglibdoc documentation.

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: 2.0.

Required Parameters

Name Type Since Description
<outputDirectory> File - The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().


Default: ${project.build.directory}/reports

Optional Parameters

Name Type Since Description
<dontRecurseIntoSubdirs> boolean - If set, only file contained directly in the specified directory are used.
<locale> String - The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: SiteTool#DEFAULT_LOCALE, SiteTool#getSiteLocales(String)
Default: default
<outputFormat> String - The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
User Property: output.format
<outputTimestamp> String - Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
Default: ${project.build.outputTimestamp}
<siteDirectory> File - Directory containing the site.xml file.
Default: ${basedir}/src/site
<srcDir> File - Directory containing tld or tag files. Subdirectories are also processed, unless the dontRecurseIntoSubdirs parameter is set.
Default: src/main/resources/META-INF
Alias: taglib.src.dir
<title> String - The title for tlddoc generated documentation.
Default: ${project.name} Tag library documentation
<tldDocDir> File - The TldDoc output dir.
Default: ${project.reporting.outputDirectory}/tlddoc
<xsltDir> File - Directory containing custom xsl files (equivalent to the "-xslt" parameter to tlddoc).

Parameter Details

<dontRecurseIntoSubdirs>

If set, only file contained directly in the specified directory are used.
  • Type: boolean
  • Required: No

<locale>

The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: SiteTool#DEFAULT_LOCALE, SiteTool#getSiteLocales(String)
  • Type: java.lang.String
  • Required: No
  • Default: default

<outputDirectory>

The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().

  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/reports

<outputFormat>

The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
  • Type: java.lang.String
  • Required: No
  • User Property: output.format

<outputTimestamp>

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.outputTimestamp}

<siteDirectory>

Directory containing the site.xml file.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/site

<srcDir>

Directory containing tld or tag files. Subdirectories are also processed, unless the dontRecurseIntoSubdirs parameter is set.
  • Type: java.io.File
  • Required: No
  • Default: src/main/resources/META-INF
  • Alias: taglib.src.dir

<title>

The title for tlddoc generated documentation.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.name} Tag library documentation

<tldDocDir>

The TldDoc output dir.
  • Type: java.io.File
  • Required: No
  • Default: ${project.reporting.outputDirectory}/tlddoc

<xsltDir>

Directory containing custom xsl files (equivalent to the "-xslt" parameter to tlddoc).
  • Type: java.io.File
  • Required: No