taglib:taglibdoc

Generates taglibdoc documentation.

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.

Optional Parameters

Name Type Description
dontRecurseIntoSubdirs boolean If set, only file contained directly in the specified directory are used.
siteRenderer Renderer Site renderer component.
srcDir File Directory containing tld or tag files. Subdirectories are also processed, unless the "dontRecurseIntoSubdirs" parameter is set.
title String title for tlddoc generated documentation.
tldDocDir File TldDoc output dir.
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

siteRenderer

Site renderer component.

  • Type: org.apache.maven.doxia.siterenderer.Renderer
  • 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
  • Expression: src/main/resources/META-INF

title

title for tlddoc generated documentation.

  • Type: java.lang.String
  • Required: No
  • Expression: ${project.name} Tag library documentation

tldDocDir

TldDoc output dir.

  • Type: java.io.File
  • Required: No
  • Expression: ${project.reporting.outputDirectory}/tlddoc

xsltDir

Directory containing custom xsl files (equivalent to the "-xslt" parameter to tlddoc).

  • Type: java.io.File
  • Required: No