← Back to branch summary

~ubuntu-branches/ubuntu/vivid/gmetrics/vivid

« back to all changes in this revision

Viewing changes to src/site/apt/gmetrics-CoberturaLineCoverageMetric.apt

  • Committer: Package Import Robot
  • Author(s): Miguel Landaeta, Miguel Landaeta, tony mancill
  • Date: 2012-01-18 20:57:50 UTC
  • mfrom: (1.1.1)
  • Revision ID: package-import@ubuntu.com-20120118205750-68fv86p7fs8xz470
Tags: 0.5-1
[Miguel Landaeta]
* New upstream release.
* Remove patch ftbfs_613266.diff since it was merged upstream.
* Update dates in copyright file.

[tony mancill]
* Set DMUA flag.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/site/apt/gmetrics-CoberturaLineCoverageMetric.apt
 
1
                --------------------------------------------------
 
2
                        GMetrics - CoberturaLineCoverage Metric
 
3
                --------------------------------------------------
 
4
 
 
5
CoberturaLineCoverage Metric
 
6
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
7
 
 
8
 Metric that measures the code coverage of source lines based on a
 
9
 {{{http://cobertura.sourceforge.net/}Cobertura}} coverage XML file.
 
10
 
 
11
 Implemented by the <<<org.gmetrics.metric.coverage.CoberturaLineCoverageMetric>>> class.
 
12
 
 
13
 
 
14
* Metric Properties
 
15
~~~~~~~~~~~~~~~~~~~
 
16
 
 
17
  The following properties can be configured for this metric within a <MetricSet>. See
 
18
  {{{./gmetrics-creating-metricset.html}Creating a MetricSet}} for information on the syntax of
 
19
  setting a metric property.
 
20
 
 
21
*-----------------+--------------------------------------------------------------------+------------------------+
 
22
| <<Property>>    | <<Description>>                                                    | <<Default Value>>      |
 
23
*-----------------+--------------------------------------------------------------------+------------------------+
 
24
| enabled         | This <<<boolean>>> property controls whether the metric is         | <<<true>>>             |
 
25
|                 | <enabled>. If set to <<<false>>>, then the metric is not included  |                        |
 
26
|                 | as part of the results or the output reports.                      |                        |
 
27
*-----------------+--------------------------------------------------------------------+------------------------+
 
28
| functions       | This <<<List\<String\>>>> property contains the names of the functions| <<<["total","average"]>>>|
 
29
|                 | to be calculated at the <class> and <package> levels and           |                        |
 
30
|                 | (potentially) included within the report(s). Valid values are:     |                        |
 
31
|                 |    - "total"                                                       |                        |
 
32
|                 |    - "average"                                                     |                        |
 
33
|                 |    - "minimum"                                                     |                        |
 
34
|                 |    - "maximum"                                                     |                        |
 
35
*-----------------+--------------------------------------------------------------------+------------------------+
 
36
| coberturaFile   | The path to the <<Cobertura>> XML file. By default, the path is    | <<<N/A>>>              |
 
37
|                 | relative to the classpath. But the path may be optionally prefixed |                        |
 
38
|                 | by any of the valid java.net.URL prefixes, such as "file:" (to load|                        |
 
39
|                 | from a relative or absolute path on the filesystem), or "http:".   |                        |
 
40
|                 | This property is REQUIRED.                                         |                        |
 
41
*-----------------+--------------------------------------------------------------------+------------------------+
 
42
| packageNamePrefixes | Optional, comma-separated list of prefixes that should be      | <<<null>>>              |
 
43
|                 | stripped from full path names before checking the <<Cobertura>>    |                        |
 
44
|                 | XML file for matching coverage information. For instance, if the   |                        |
 
45
|                 | <<GMetrics>> Ant task is configured to pull in all *.groovy files  |                        |
 
46
|                 | from "src/main/groovy/**", then all of the package paths will be   |                        |
 
47
|                 | prefixed with "src/main/groovy", which is not part of the actual   |                        |
 
48
|                 | package name recorded in the <<Cobertura>> XML file. In that case, |                        |
 
49
|                 | set the <packageNamePrefixes> property to "src/main/groovy".       |                        |
 
50
*-----------------+--------------------------------------------------------------------+------------------------+
 
51
 
 
52
 
 
53
* References
 
54
~~~~~~~~~~~~
 
55
 
 
56
 * {{{http://cobertura.sourceforge.net/}Cobertura}} -- <Cobertura is a free Java tool that calculates the percentage
 
57
 of code accessed by tests. It can be used to identify which parts of your Java program are lacking test coverage.>