Required Parameters

Name	Type	Description
libraries	List	Library specification locations of the libraries to be documented, separated by comma. Eg. "/org/apache/tapestry/Framework.library, /org/apache/tapestry/wml/WML.library"
reportOutputDirectory	File	Specifies the destination directory where Tapdoc saves the generated HTML files.

Optional Parameters

Name	Type	Description
aggregate	boolean	Whether to build an aggregated report at the root, or build individual reports. Default value is false.
artifactMetadataSource	ArtifactMetadataSource	Used to resolve artifacts of aggregated modules
description	String	The description of the tapdoc report. Default value is Tapestry component reference..
destDir	String	The name of the destination directory. Default value is tapdocs.
factory	ArtifactFactory	Factory for creating artifact objects
ignoreAbstract	boolean	Ignore abstract classes. By default, all abstract classes found are considered tapestry components. Default value is false.
localRepository	ArtifactRepository	The local repository where the artifacts are located
name	String	The name of the tapdoc report. Default value is TapDocs.
packages	String	Packages to search for components (separated by ':'). If not specified, it's derived from the libraries parameter.
pluginArtifacts	List	No description.
resolver	ArtifactResolver	Used for resolving artifacts
showErrors	boolean	Whether to log to the console any runtime errors. Default value is false.
siteRenderer	Renderer	No description.
trimClasspath	boolean	In several projects, the discovered classpath can grow very large, causing the java/javadoc execution to fail due to OS command limits. With this setting on (the default), tapdoc will construct a classpath that only includes tapestry, hivemind and tacos jars. Default value is true.
useJavadocExecutable	boolean	The custom doclet that tapdoc must apply to the source code has traditionally used 'java ... com.sun.tools.javadoc.Main ...'. However, there's now an option to execute 'javadoc ...' instead, so, if the default fails, try using this option. Default value is false.

Parameter Details

aggregate

Whether to build an aggregated report at the root, or build individual reports.

• Type: boolean
• Required: No
• Expression: ${aggregate}
• Default: false

---

artifactMetadataSource Used to resolve artifacts of aggregated modules

• Type: org.apache.maven.artifact.metadata.ArtifactMetadataSource
• Required: No

---

description The description of the tapdoc report.

• Type: java.lang.String
• Required: No
• Expression: ${description}
• Default: Tapestry component reference.

---

destDir The name of the destination directory.

• Type: java.lang.String
• Required: No
• Expression: ${destDir}
• Default: tapdocs

---

factory Factory for creating artifact objects

• Type: org.apache.maven.artifact.factory.ArtifactFactory
• Required: No

---

ignoreAbstract Ignore abstract classes. By default, all abstract classes found are considered tapestry components.

• Type: boolean
• Required: No
• Default: false

---

libraries Library specification locations of the libraries to be documented, separated by comma. Eg. "/org/apache/tapestry/Framework.library, /org/apache/tapestry/wml/WML.library"

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

---

localRepository The local repository where the artifacts are located

• Type: org.apache.maven.artifact.repository.ArtifactRepository
• Required: No
• Expression: ${localRepository}

---

name The name of the tapdoc report.

• Type: java.lang.String
• Required: No
• Expression: ${name}
• Default: TapDocs

---

packages Packages to search for components (separated by ':'). If not specified, it's derived from the libraries parameter.

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

---

pluginArtifacts No Description.

• Type: java.util.List
• Required: No
• Expression: ${plugin.artifacts}

---

reportOutputDirectory Specifies the destination directory where Tapdoc saves the generated HTML files.

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

---

resolver Used for resolving artifacts

• Type: org.apache.maven.artifact.resolver.ArtifactResolver
• Required: No

---

showErrors Whether to log to the console any runtime errors.

• Type: boolean
• Required: No
• Default: false

---

siteRenderer No Description.

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

---

trimClasspath In several projects, the discovered classpath can grow very large, causing the java/javadoc execution to fail due to OS command limits. With this setting on (the default), tapdoc will construct a classpath that only includes tapestry, hivemind and tacos jars.

• Type: boolean
• Required: No
• Default: true

---

useJavadocExecutable The custom doclet that tapdoc must apply to the source code has traditionally used 'java ... com.sun.tools.javadoc.Main ...'. However, there's now an option to execute 'javadoc ...' instead, so, if the default fails, try using this option.

• Type: boolean
• Required: No
• Default: false