Required Parameters

Name	Type	Description
javadocDir	String	Subdirectory containing the javadocs. Must be changed if you configure something non-default in the javadoc-plugin Default value is apidocs.
outDir	File	Location of the site. Default value is ${project.reporting.outputDirectory}.
reportSubDir	String	The name of the sub-directory to contain the generated hivedocs. Default value is hivedocs.
resources	List	List of standard-resources to search for hivemodule.xml's. Can't be changed by the user directly. To include additional resources set the optional parameter extraResources Default value is ${project.resources}.

Optional Parameters

Name	Type	Description
extraResources	String[]	List of resources to search for hivemodule.xml's in addition to the standard resources.
siteRenderer	SiteRenderer	Generates the site report

Parameter Details

extraResources

List of resources to search for hivemodule.xml's in addition to the standard resources.

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

---

javadocDir Subdirectory containing the javadocs. Must be changed if you configure something non-default in the javadoc-plugin

• Type: java.lang.String
• Required: Yes
• Default: apidocs

---

outDir Location of the site.

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

---

reportSubDir The name of the sub-directory to contain the generated hivedocs.

• Type: java.lang.String
• Required: Yes
• Default: hivedocs

---

resources List of standard-resources to search for hivemodule.xml's. Can't be changed by the user directly. To include additional resources set the optional parameter extraResources

• Type: java.util.List
• Required: Yes
• Default: ${project.resources}

---

siteRenderer Generates the site report

• Type: org.codehaus.doxia.site.renderer.SiteRenderer
• Required: No