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

« back to all changes in this revision

Viewing changes to src/site/apt/gmetrics-ClassCountMetric.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:
 
1
                --------------------------------------------------
 
2
                                          GMetrics - ClassCount Metric
 
3
                --------------------------------------------------
 
4
 
 
5
ClassCount Metric
 
6
~~~~~~~~~~~~~~~~~~~~~
 
7
 
 
8
 Metric for counting the number of classes in each package. This metric counts
 
9
 the number of classes, interfaces and enums within a package.
 
10
 
 
11
 Implemented by the <<<org.gmetrics.metric.classcount.ClassCountMetric>>> 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