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

Optional Parameters

Name Type Since Description
<dontRecurseIntoSubdirs> boolean - If set, only file contained directly in the specified directory are used.
<srcDir> File - Directory containing tld or tag files. Subdirectories are also processed, unless the "dontRecurseIntoSubdirs" parameter is set.
Default value is: src/main/resources/META-INF.
Alias is: taglib.src.dir.
<title> String - title for tlddoc generated documentation.
Default value is: ${project.name} Tag library documentation.
<tldDocDir> File - TldDoc output dir.
Default value is: ${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

<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>

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

<tldDocDir>

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