Description
The <clover-html-report> task generates a full HTML report with sensible default settings. If configured, a history point is also generated prior to generation of the full report. For more configuration options, use the <clover-report> task.
Parameters
Attribute |
Description |
Required |
outdir |
The directory to write the report to. |
Yes. |
initstring |
The path to the Clover database. If not specified, Clover will use the initstring set by a previous execution of <clover-setup/> in the current build sequence. Otherwise, the default database location will be used. |
No. |
title |
The title to use in the report. |
No. |
historydir |
The directory for Clover history points. If this attribute is set, a new history point will be generated prior to the generation of the full report. For more information, see <clover-historypoint>. |
No. |
testresultsdir |
The directory containing the XML results of the unit tests. Clover will look for all TEST*.xml files in this directory. This attribute is generally not required by most users, as the built-in test results will provide all required information in the majority of cases. For more details please see 'Advanced Usage'. |
No. |
historyIncludes |
An Ant GLOB to select specific history point files within the historyDir directory |
No. Default is clover-*.xml.gz |
maxtestsperfile |
This limits the number of tests displayed for each file. |
No. |
numThreads |
The number of threads to start when generating an HTML report. A value of 0 will disable multi-threading for report generation. |
No. Default is 2. |
projectName |
Overrides the project name set in the Ant build file. This is used for display purposes only. |
No; defaults to the project name of the Ant build file. |
Examples
This is the simplest way to generate an HTML report. It will be written to the directory "clover/report".
This will generate a report in the "build/clover/report" directory. A history point will be created in the "clover/historypoints" directory, and all history points in that directory will be used to generate the historical section of the report. The report will be titled "MyProject Coverage".