Fix: Add missing and update existing docblocks

Author: localheinz

src/System/Git/GitCommand.php

@@ -7,13 +7,19 @@ class GitCommand extends SystemCommand
 {
  protected $commandPath = 'git';
 
+ /**
+ * @return string
+ */
  public function getHead()
  {
  $command = $this->createCommand("log -1 --pretty=format:'%H'");
 
  return current($this->executeCommand($command));
  }
 
+ /**
+ * @return string|null
+ */
  public function getBranch()
  {
  $command = $this->createCommand("branch");
@@ -28,6 +34,9 @@ public function getBranch()
  return null;
  }
 
+ /**
+ * @return int
+ */
  public function getCommittedAt()
  {
  $command = $this->createCommand("log -1 --pretty=format:'%ct'");

src/TestReporter/ApiClient.php

@@ -5,6 +5,9 @@
 
 class ApiClient
 {
+ /**
+ * @var string
+ */
  protected $apiHost = "https://codeclimate.com";
 
  /**

src/TestReporter/CoverageCollector.php

@@ -7,6 +7,9 @@
 
 class CoverageCollector
 {
+ /**
+ * @var Jobs
+ */
  protected $api;
 
  /**
@@ -15,6 +18,11 @@ class CoverageCollector
  */
  protected $cloverPaths = [ ];
 
+ /**
+ * CoverageCollector constructor.
+ *
+ * @param string[] $paths
+ */
  public function __construct($paths)
  {
  $rootDir = getcwd();
@@ -35,7 +43,7 @@ public function __construct($paths)
  /**
  * Set a list of Clover XML paths
  *
- * @param array $paths Array of relative paths to Clovers XML files
+ * @param string[] $paths Array of relative paths to Clovers XML files
  */
  public function setCloverPaths($paths)
  {
@@ -44,13 +52,16 @@ public function setCloverPaths($paths)
 
  /**
  * Get a list of Clover XML paths
- * @return array Array of relative Clover XML file locations
+ * @return string[] Array of relative Clover XML file locations
  */
  public function getCloverPaths()
  {
  return $this->cloverPaths;
  }
 
+ /**
+ * @return JsonFile
+ */
  public function collectAsJson()
  {
  $cloverJsonFile = $this->api->collectCloverXml()->getJsonFile();

src/TestReporter/Entity/CiInfo.php

@@ -3,6 +3,9 @@
 
 class CiInfo
 {
+ /**
+ * @return array
+ */
  public function toArray()
  {
  if (isset($_SERVER["TRAVIS"])) {
@@ -40,6 +43,9 @@ public function toArray()
  return [ ];
  }
 
+ /**
+ * @return array
+ */
  protected function travisProperties()
  {
  return [
@@ -50,6 +56,9 @@ protected function travisProperties()
  ];
  }
 
+ /**
+ * @return array
+ */
  protected function circleProperties()
  {
  return [
@@ -60,6 +69,9 @@ protected function circleProperties()
  ];
  }
 
+ /**
+ * @return array
+ */
  protected function semaphoreProperties()
  {
  return [
@@ -69,6 +81,9 @@ protected function semaphoreProperties()
  ];
  }
 
+ /**
+ * @return array
+ */
  protected function jenkinsProperties()
  {
  return [
@@ -80,6 +95,9 @@ protected function jenkinsProperties()
  ];
  }
 
+ /**
+ * @return array
+ */
  protected function tddiumProperties()
  {
  return [
@@ -89,6 +107,9 @@ protected function tddiumProperties()
  ];
  }
 
+ /**
+ * @return array
+ */
  protected function codeshipProperties()
  {
  return [
@@ -100,6 +121,9 @@ protected function codeshipProperties()
  ];
  }
 
+ /**
+ * @return array
+ */
  protected function buildkiteProperties()
  {
  return [
@@ -112,6 +136,9 @@ protected function buildkiteProperties()
  ];
  }
 
+ /**
+ * @return array
+ */
  protected function werckerProperties()
  {
  return [

src/TestReporter/Entity/JsonFile.php

@@ -31,6 +31,9 @@ public function getRepoToken()
  return $_SERVER["CODECLIMATE_REPO_TOKEN"];
  }
 
+ /**
+ * @return array
+ */
  protected function getEnvironment()
  {
  return [
@@ -39,6 +42,9 @@ protected function getEnvironment()
  ];
  }
 
+ /**
+ * @return array
+ */
  protected function collectGitInfo()
  {
  $command = new GitCommand();
@@ -50,13 +56,19 @@ protected function collectGitInfo()
  ];
  }
 
+ /**
+ * @return array
+ */
  protected function collectCiServiceInfo()
  {
  $ciInfo = new CiInfo();
 
  return $ciInfo->toArray();
  }
 
+ /**
+ * @return array
+ */
  protected function collectSourceFiles()
  {
  return array_map(function (SourceFile $sourceFile) {
@@ -68,6 +80,10 @@ protected function collectSourceFiles()
  }, $this->getSourceFiles());
  }
 
+ /**
+ * @param SourceFile $sourceFile
+ * @return string
+ */
  protected function calculateBlobId(SourceFile $sourceFile)
  {
  $content = file_get_contents($sourceFile->getPath());

tests/Unit/ApplicationTest.php

@@ -8,7 +8,10 @@ class ApplicationTest extends \PHPUnit_Framework_TestCase
 {
  const PROJECT_DIR = "/tmp/php-test-reporter-example-project";
 
- private $srcDir;
+ /**
+ * @var string
+ */
+ protected $srcDir;
 
  protected function setUp()
  {