Skip to content
This repository was archived by the owner on Sep 18, 2019. It is now read-only.

Commit 6a602a9

Browse files
author
Martins Sipenko
committed
Added code comments
1 parent 8da2dd3 commit 6a602a9

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

src/CodeClimate/Bundle/TestReporterBundle/CoverageCollector.php

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@
88

99
class CoverageCollector
1010
{
11-
// const RELATIVE_PATH = 'build/logs/clover.xml';
12-
1311
protected $api;
12+
13+
/**
14+
* Array that holds list of relative paths to Clover XML files
15+
* @var array
16+
*/
1417
protected $cloverPaths = array();
1518

1619
public function __construct($paths)
@@ -26,16 +29,23 @@ public function __construct($paths)
2629
$this->api = new Jobs($config);
2730
}
2831

32+
/**
33+
* Set a list of Clover XML paths
34+
* @param array $paths Array of relative paths to Clovers XML files
35+
*/
2936
public function setCloverPaths($paths)
3037
{
3138
$this->cloverPaths = $paths;
3239
}
3340

41+
/**
42+
* Get a list of Clover XML paths
43+
* @return array Array of relative Clover XML file locations
44+
*/
3445
public function getCloverPaths()
3546
{
3647
return $this->cloverPaths;
3748
}
38-
3949
public function collectAsJson()
4050
{
4151
$cloverJsonFile = $this->api->collectCloverXml()->getJsonFile();

0 commit comments

Comments
 (0)