Apache MyFaces
Project Documentation
Foundation

myfaces-builder:tagdoc-index

Report for generating JSF tagdoc index based on myfaces-metadata.xml parsing. The content is generated using velocity in xdoc files (see TagdocContentMojo).

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.

Required Parameters

Name Type Description
outputDirectory File Specifies the directory where the report will be generated Default value is ${project.reporting.outputDirectory}.
siteDirectory File Directory where the original site is present. (TRIED using ${baseDir}/src/site; that inserted a 'null' into the string for some reason. TRIED using ${siteDirectory}, which was undefined. TRIED ${project.directory}src/site; which also inserted a null. ${project.build.directory}/../src/site seems to work, though it assumes that ${project.build.directory} is ${project.directory}/target. Default value is ${project.build.directory}/../src/site/.

Optional Parameters

Name Type Description
buildDirectory File No description.
metadataFile String Injected name of file generated by earlier run of BuildMetaDataMojo goal.
modelIds List No description.
siteRenderer Renderer No description.
taglibs Map No description.

Parameter Details

buildDirectory

No Description.

  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/generated-resources/myfaces-builder-plugin

metadataFile

Injected name of file generated by earlier run of BuildMetaDataMojo goal.

  • Type: java.lang.String
  • Required: No

modelIds

No Description.

  • Type: java.util.List
  • Required: No

outputDirectory

Specifies the directory where the report will be generated

  • Type: java.io.File
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}

siteDirectory

Directory where the original site is present. (TRIED using ${baseDir}/src/site; that inserted a 'null' into the string for some reason. TRIED using ${siteDirectory}, which was undefined. TRIED ${project.directory}src/site; which also inserted a null. ${project.build.directory}/../src/site seems to work, though it assumes that ${project.build.directory} is ${project.directory}/target.

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

siteRenderer

No Description.

  • Type: org.apache.maven.doxia.siterenderer.Renderer
  • Required: No

taglibs

No Description.

  • Type: java.util.Map
  • Required: No