tagdoc:tagdoc

Report for generating JSF tagdoc based on faces-config.xml parsing. Note that this is not really an AbstractMavenMultiPageReport - the secondary pages are manually generated XDoc. I tried using the true multipage report approach, and ran into Maven bugs (as of Maven 2.0.2, site 2.0b4).

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/.
taglibs Map No description.

Optional Parameters

Name Type Description
siteRenderer SiteRenderer No description.

Parameter Details

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.codehaus.doxia.site.renderer.SiteRenderer
  • Required : No

taglibs

No Description.

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