Update PHPDoc.

tomzx · tomzx · commit 1aabf1e068d9 · 2018-02-10T16:51:07.000-05:00
diff --git a/src/PHPSemVerChecker/Analyzer/ClassAnalyzer.php b/src/PHPSemVerChecker/Analyzer/ClassAnalyzer.php
@@ -8,8 +8,16 @@
 use PHPSemVerChecker\Report\Report;
 
 class ClassAnalyzer {
+	/**
+	 * @var string
+	 */
 	protected $context = 'class';
 
+	/**
+	 * @param \PHPSemVerChecker\Registry\Registry $registryBefore
+	 * @param \PHPSemVerChecker\Registry\Registry $registryAfter
+	 * @return \PHPSemVerChecker\Report\Report
+	 */
 	public function analyze(Registry $registryBefore, Registry $registryAfter)
 	{
 		$report = new Report();
diff --git a/src/PHPSemVerChecker/Analyzer/ClassMethodAnalyzer.php b/src/PHPSemVerChecker/Analyzer/ClassMethodAnalyzer.php
@@ -20,8 +20,17 @@
 use PHPSemVerChecker\Report\Report;
 
 class ClassMethodAnalyzer {
+	/**
+	 * @var string
+	 */
 	protected $context;
+	/**
+	 * @var null|string
+	 */
 	protected $fileBefore;
+	/**
+	 * @var null|string
+	 */
 	protected $fileAfter;
 
 	/**
@@ -36,6 +45,11 @@ public function __construct($context, $fileBefore = null, $fileAfter = null)
 		$this->fileAfter = $fileAfter;
 	}
 
+	/**
+	 * @param \PhpParser\Node\Stmt $contextBefore
+	 * @param \PhpParser\Node\Stmt $contextAfter
+	 * @return \PHPSemVerChecker\Report\Report
+	 */
 	public function analyze(Stmt $contextBefore, Stmt $contextAfter)
 	{
 		$report = new Report();
diff --git a/src/PHPSemVerChecker/Analyzer/FunctionAnalyzer.php b/src/PHPSemVerChecker/Analyzer/FunctionAnalyzer.php
@@ -17,11 +17,13 @@
 use PHPSemVerChecker\Operation\FunctionParameterTypingAdded;
 use PHPSemVerChecker\Operation\FunctionParameterTypingRemoved;
 use PHPSemVerChecker\Operation\FunctionRemoved;
-use PHPSemVerChecker\Operation\Unknown;
 use PHPSemVerChecker\Registry\Registry;
 use PHPSemVerChecker\Report\Report;
 
 class FunctionAnalyzer {
+	/**
+	 * @var string
+	 */
 	protected $context = 'function';
 
 	/**
diff --git a/src/PHPSemVerChecker/Analyzer/InterfaceAnalyzer.php b/src/PHPSemVerChecker/Analyzer/InterfaceAnalyzer.php
@@ -8,8 +8,16 @@
 use PHPSemVerChecker\Report\Report;
 
 class InterfaceAnalyzer {
+	/**
+	 * @var string
+	 */
 	protected $context = 'interface';
 
+	/**
+	 * @param \PHPSemVerChecker\Registry\Registry $registryBefore
+	 * @param \PHPSemVerChecker\Registry\Registry $registryAfter
+	 * @return \PHPSemVerChecker\Report\Report
+	 */
 	public function analyze(Registry $registryBefore, Registry $registryAfter)
 	{
 		$report = new Report();
diff --git a/src/PHPSemVerChecker/Analyzer/PropertyAnalyzer.php b/src/PHPSemVerChecker/Analyzer/PropertyAnalyzer.php
@@ -34,6 +34,11 @@ public function __construct($context, $fileBefore = null, $fileAfter = null)
 		$this->fileAfter = $fileAfter;
 	}
 
+	/**
+	 * @param \PhpParser\Node\Stmt $contextBefore
+	 * @param \PhpParser\Node\Stmt $contextAfter
+	 * @return \PHPSemVerChecker\Report\Report
+	 */
 	public function analyze(Stmt $contextBefore, Stmt $contextAfter)
 	{
 		$report = new Report();
@@ -72,6 +77,10 @@ public function analyze(Stmt $contextBefore, Stmt $contextAfter)
 		return $report;
 	}
 
+	/**
+	 * @param \PhpParser\Node\Stmt $context
+	 * @return array
+	 */
 	protected function getProperties(Stmt $context)
 	{
 		$properties = [];
@@ -83,6 +92,10 @@ protected function getProperties(Stmt $context)
 		return $properties;
 	}
 
+	/**
+	 * @param \PhpParser\Node\Stmt\Property $property
+	 * @return string
+	 */
 	protected function getName(Property $property)
 	{
 		return $property->props[0]->name;
diff --git a/src/PHPSemVerChecker/Analyzer/TraitAnalyzer.php b/src/PHPSemVerChecker/Analyzer/TraitAnalyzer.php
@@ -8,8 +8,16 @@
 use PHPSemVerChecker\Report\Report;
 
 class TraitAnalyzer {
+	/**
+	 * @var string
+	 */
 	protected $context = 'trait';
 
+	/**
+	 * @param \PHPSemVerChecker\Registry\Registry $registryBefore
+	 * @param \PHPSemVerChecker\Registry\Registry $registryAfter
+	 * @return \PHPSemVerChecker\Report\Report
+	 */
 	public function analyze(Registry $registryBefore, Registry $registryAfter)
 	{
 		$report = new Report();
diff --git a/src/PHPSemVerChecker/Comparator/Node.php b/src/PHPSemVerChecker/Comparator/Node.php
@@ -4,6 +4,11 @@
 
 class Node
 {
+	/**
+	 * @param \PhpParser\Node $nodeA
+	 * @param \PhpParser\Node $nodeB
+	 * @return bool
+	 */
 	public static function isEqual(\PhpParser\Node $nodeA, \PhpParser\Node $nodeB)
 	{
 		if ($nodeA->getType() !== $nodeB->getType()) {
diff --git a/src/PHPSemVerChecker/Configuration/Configuration.php b/src/PHPSemVerChecker/Configuration/Configuration.php
@@ -18,6 +18,7 @@ class Configuration
 
 	/**
 	 * @param string|array $path
+	 * @throws \Noodlehaus\Exception\EmptyDirectoryException
 	 */
 	public function __construct($path)
 	{
@@ -28,14 +29,17 @@ public function __construct($path)
 	/**
 	 * @param string|array $file
 	 * @return \PHPSemVerChecker\Configuration\Configuration
+	 * @throws \Noodlehaus\Exception\EmptyDirectoryException
 	 */
 	public static function fromFile($file)
 	{
 		return new Configuration($file);
 	}
 
 	/**
+	 * @param string $name
 	 * @return \PHPSemVerChecker\Configuration\Configuration
+	 * @throws \Noodlehaus\Exception\EmptyDirectoryException
 	 */
 	public static function defaults($name)
 	{
diff --git a/src/PHPSemVerChecker/Configuration/LevelMapping.php b/src/PHPSemVerChecker/Configuration/LevelMapping.php
@@ -6,6 +6,9 @@
 
 class LevelMapping
 {
+	/**
+	 * @var array
+	 */
 	public static $mapping = [
 		'V001' => Level::MAJOR,
 		'V002' => Level::MAJOR,
@@ -123,11 +126,18 @@ class LevelMapping
 		'V117' => Level::MAJOR,
 	];
 
+	/**
+	 * @param string $code
+	 * @return int
+	 */
 	public static function getLevelForCode($code)
 	{
 		return static::$mapping[$code];
 	}
 
+	/**
+	 * @param array $mapping
+	 */
 	public static function setOverrides(array $mapping)
 	{
 		foreach ($mapping as $code => $level) {
diff --git a/src/PHPSemVerChecker/Console/Application.php b/src/PHPSemVerChecker/Console/Application.php
@@ -9,6 +9,9 @@ class Application extends SymfonyApplication {
 
 	const VERSION = '@package_version@';
 
+	/**
+	 * @var string
+	 */
 	private static $logo = '    ____  ______   _______
    / __ \/ ___/ | / / ___/
   / /_/ /__  /| |/ / /__
@@ -21,11 +24,17 @@ public function __construct()
 		parent::__construct('PHP Semantic Versioning Checker by Tom Rochette', self::VERSION);
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getHelp()
 	{
 		return self::$logo . parent::getHelp();
 	}
 
+	/**
+	 * @return array|\Symfony\Component\Console\Command\Command[]
+	 */
 	protected function getDefaultCommands()
 	{
 		$commands = parent::getDefaultCommands();
diff --git a/src/PHPSemVerChecker/Console/Command/BaseCommand.php b/src/PHPSemVerChecker/Console/Command/BaseCommand.php
@@ -19,6 +19,7 @@ class BaseCommand extends Command
 	/**
 	 * @param \Symfony\Component\Console\Input\InputInterface   $input
 	 * @param \Symfony\Component\Console\Output\OutputInterface $output
+	 * @throws \Noodlehaus\Exception\EmptyDirectoryException
 	 */
 	protected function initialize(InputInterface $input, OutputInterface $output)
 	{
diff --git a/src/PHPSemVerChecker/Node/Statement/ClassMethod.php b/src/PHPSemVerChecker/Node/Statement/ClassMethod.php
@@ -6,6 +6,11 @@
 use PhpParser\Node\Stmt\ClassMethod as BaseClassMethod;
 
 class ClassMethod {
+	/**
+	 * @param \PhpParser\Node\Stmt             $context
+	 * @param \PhpParser\Node\Stmt\ClassMethod $classMethod
+	 * @return string
+	 */
 	public static function getFullyQualifiedName(Stmt $context, BaseClassMethod $classMethod)
 	{
 		$namespace = $context->name;
diff --git a/src/PHPSemVerChecker/Node/Statement/Class_.php b/src/PHPSemVerChecker/Node/Statement/Class_.php
@@ -5,6 +5,10 @@
 use PhpParser\Node\Stmt\Class_ as BaseClass;
 
 class Class_ {
+	/**
+	 * @param \PhpParser\Node\Stmt\Class_ $class
+	 * @return null|string
+	 */
 	public static function getFullyQualifiedName(BaseClass $class)
 	{
 		if (isset($class->namespacedName)) {
diff --git a/src/PHPSemVerChecker/Node/Statement/Function_.php b/src/PHPSemVerChecker/Node/Statement/Function_.php
@@ -5,6 +5,10 @@
 use PhpParser\Node\Stmt\Function_ as BaseFunction;
 
 class Function_ {
+	/**
+	 * @param \PhpParser\Node\Stmt\Function_ $function
+	 * @return string
+	 */
 	public static function getFullyQualifiedName(BaseFunction $function)
 	{
 		if (isset($function->namespacedName)) {
diff --git a/src/PHPSemVerChecker/Node/Statement/Interface_.php b/src/PHPSemVerChecker/Node/Statement/Interface_.php
@@ -5,6 +5,10 @@
 use PhpParser\Node\Stmt\Interface_ as BaseInterface;
 
 class Interface_ {
+	/**
+	 * @param \PhpParser\Node\Stmt\Interface_ $interface
+	 * @return null|string
+	 */
 	public static function getFullyQualifiedName(BaseInterface $interface)
 	{
 		if (isset($interface->namespacedName)) {
diff --git a/src/PHPSemVerChecker/Node/Statement/Property.php b/src/PHPSemVerChecker/Node/Statement/Property.php
@@ -6,6 +6,11 @@
 use PhpParser\Node\Stmt\Property as BaseProperty;
 
 class Property {
+	/**
+	 * @param \PhpParser\Node\Stmt          $context
+	 * @param \PhpParser\Node\Stmt\Property $property
+	 * @return string
+	 */
 	public static function getFullyQualifiedName(Stmt $context, BaseProperty $property)
 	{
 		$namespace = $context->name;
diff --git a/src/PHPSemVerChecker/Node/Statement/Trait_.php b/src/PHPSemVerChecker/Node/Statement/Trait_.php
@@ -5,6 +5,10 @@
 use PhpParser\Node\Stmt\Trait_ as BaseTrait;
 
 class Trait_ {
+	/**
+	 * @param \PhpParser\Node\Stmt\Trait_ $trait
+	 * @return null|string
+	 */
 	public static function getFullyQualifiedName(BaseTrait $trait)
 	{
 		if (isset($trait->namespacedName)) {
diff --git a/src/PHPSemVerChecker/Operation/ClassRemoved.php b/src/PHPSemVerChecker/Operation/ClassRemoved.php
@@ -41,6 +41,9 @@ public function getLocation()
 		return $this->fileBefore;
 	}
 
+	/**
+	 * @return int
+	 */
 	public function getLine()
 	{
 		return $this->classBefore->getLine();
diff --git a/src/PHPSemVerChecker/Operation/Operation.php b/src/PHPSemVerChecker/Operation/Operation.php
@@ -37,6 +37,9 @@ public function setCode($code)
 		return $this;
 	}
 
+	/**
+	 * @return int
+	 */
 	public function getLevel()
 	{
 		return LevelMapping::getLevelForCode($this->getCode());
@@ -66,6 +69,9 @@ public function setReason($reason)
 	 */
 	public abstract function getLocation();
 
+	/**
+	 * @return int
+	 */
 	public abstract function getLine();
 
 	/**
diff --git a/src/PHPSemVerChecker/Operation/PropertyOperation.php b/src/PHPSemVerChecker/Operation/PropertyOperation.php
@@ -2,6 +2,8 @@
 
 namespace PHPSemVerChecker\Operation;
 
+use PhpParser\Node\Stmt;
+
 abstract class PropertyOperation extends Operation {
 	/**
 	 * @var string
@@ -12,17 +14,27 @@ abstract class PropertyOperation extends Operation {
 	 */
 	protected $visibility;
 
+	/**
+	 * @return string
+	 */
 	public function getCode()
 	{
 		return $this->code[$this->context][Visibility::get($this->visibility)];
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getReason()
 	{
 		return '[' . Visibility::toString($this->visibility) . '] ' . $this->reason;
 	}
 
-	protected function getVisibility($context)
+	/**
+	 * @param \PhpParser\Node\Stmt $context
+	 * @return int
+	 */
+	protected function getVisibility(Stmt $context)
 	{
 		return Visibility::getForContext($context);
 	}
diff --git a/src/PHPSemVerChecker/Report/Report.php b/src/PHPSemVerChecker/Report/Report.php
diff --git a/src/PHPSemVerChecker/Reporter/JsonReporter.php b/src/PHPSemVerChecker/Reporter/JsonReporter.php
diff --git a/src/PHPSemVerChecker/Reporter/Reporter.php b/src/PHPSemVerChecker/Reporter/Reporter.php
diff --git a/src/PHPSemVerChecker/Wrapper/Filesystem.php b/src/PHPSemVerChecker/Wrapper/Filesystem.php

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,11 @@ public function __construct($context, $fileBefore = null, $fileAfter = null)`
`34`	`34`	`$this->fileAfter = $fileAfter;`
`35`	`35`	`}`
`36`	`36`
	`37`	`+ /**`
	`38`	`+ * @param \PhpParser\Node\Stmt $contextBefore`
	`39`	`+ * @param \PhpParser\Node\Stmt $contextAfter`
	`40`	`+ * @return \PHPSemVerChecker\Report\Report`
	`41`	`+ */`
`37`	`42`	`public function analyze(Stmt $contextBefore, Stmt $contextAfter)`
`38`	`43`	`{`
`39`	`44`	`$report = new Report();`
`@@ -72,6 +77,10 @@ public function analyze(Stmt $contextBefore, Stmt $contextAfter)`
`72`	`77`	`return $report;`
`73`	`78`	`}`
`74`	`79`
	`80`	`+ /**`
	`81`	`+ * @param \PhpParser\Node\Stmt $context`
	`82`	`+ * @return array`
	`83`	`+ */`
`75`	`84`	`protected function getProperties(Stmt $context)`
`76`	`85`	`{`
`77`	`86`	`$properties = [];`
`@@ -83,6 +92,10 @@ protected function getProperties(Stmt $context)`
`83`	`92`	`return $properties;`
`84`	`93`	`}`
`85`	`94`
	`95`	`+ /**`
	`96`	`+ * @param \PhpParser\Node\Stmt\Property $property`
	`97`	`+ * @return string`
	`98`	`+ */`
`86`	`99`	`protected function getName(Property $property)`
`87`	`100`	`{`
`88`	`101`	`return $property->props[0]->name;`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,11 @@`
`4`	`4`
`5`	`5`	`class Node`
`6`	`6`	`{`
	`7`	`+ /**`
	`8`	`+ * @param \PhpParser\Node $nodeA`
	`9`	`+ * @param \PhpParser\Node $nodeB`
	`10`	`+ * @return bool`
	`11`	`+ */`
`7`	`12`	`public static function isEqual(\PhpParser\Node $nodeA, \PhpParser\Node $nodeB)`
`8`	`13`	`{`
`9`	`14`	`if ($nodeA->getType() !== $nodeB->getType()) {`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ class Configuration`
`18`	`18`
`19`	`19`	`/**`
`20`	`20`	`* @param string\|array $path`
	`21`	`+ * @throws \Noodlehaus\Exception\EmptyDirectoryException`
`21`	`22`	`*/`
`22`	`23`	`public function __construct($path)`
`23`	`24`	`{`
`@@ -28,14 +29,17 @@ public function __construct($path)`
`28`	`29`	`/**`
`29`	`30`	`* @param string\|array $file`
`30`	`31`	`* @return \PHPSemVerChecker\Configuration\Configuration`
	`32`	`+ * @throws \Noodlehaus\Exception\EmptyDirectoryException`
`31`	`33`	`*/`
`32`	`34`	`public static function fromFile($file)`
`33`	`35`	`{`
`34`	`36`	`return new Configuration($file);`
`35`	`37`	`}`
`36`	`38`
`37`	`39`	`/**`
	`40`	`+ * @param string $name`
`38`	`41`	`* @return \PHPSemVerChecker\Configuration\Configuration`
	`42`	`+ * @throws \Noodlehaus\Exception\EmptyDirectoryException`
`39`	`43`	`*/`
`40`	`44`	`public static function defaults($name)`
`41`	`45`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,9 @@ class Application extends SymfonyApplication {`
`9`	`9`
`10`	`10`	`const VERSION = '@package_version@';`
`11`	`11`
	`12`	`+ /**`
	`13`	`+ * @var string`
	`14`	`+ */`
`12`	`15`	`private static $logo = ' ____ ______ _______`
`13`	`16`	`/ __ \/ ___/ \| / / ___/`
`14`	`17`	`/ /_/ /__ /\| \|/ / /__`
`@@ -21,11 +24,17 @@ public function __construct()`
`21`	`24`	`parent::__construct('PHP Semantic Versioning Checker by Tom Rochette', self::VERSION);`
`22`	`25`	`}`
`23`	`26`
	`27`	`+ /**`
	`28`	`+ * @return string`
	`29`	`+ */`
`24`	`30`	`public function getHelp()`
`25`	`31`	`{`
`26`	`32`	`return self::$logo . parent::getHelp();`
`27`	`33`	`}`
`28`	`34`
	`35`	`+ /**`
	`36`	`+ * @return array\|\Symfony\Component\Console\Command\Command[]`
	`37`	`+ */`
`29`	`38`	`protected function getDefaultCommands()`
`30`	`39`	`{`
`31`	`40`	`$commands = parent::getDefaultCommands();`