mikekamornikov / UpgradeSpec

src/Cache/Adapter/AdapterTrait.php

Doc Comments +2 added lines, -2 removed lines

@@ -19,7 +19,7 @@ 
      * @param iterable $keys    a list of keys that can obtained in a single operation
      * @param mixed    $default default value to return for keys that do not exist
      *
-     * @return iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
+     * @return \Generator A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
      */
     public function getMultiple($keys, $default = null)
     {
@@ -88,7 +88,7 @@ 
     }
 
     /**
-     * @param $key
+     * @param string $key
      *
      * @throws InvalidArgumentException
      */

src/Cache/Cache.php

Doc Comments +3 added lines, -3 removed lines

@@ -23,7 +23,7 @@ 
     }
 
     /**
-     * @param $key
+     * @param string $key
      *
      * @return bool
      */
@@ -37,7 +37,7 @@ 
     }
 
     /**
-     * @param $key
+     * @param string $key
      * @param null $default
      *
      * @return mixed
@@ -56,7 +56,7 @@ 
     }
 
     /**
-     * @param $key
+     * @param string $key
      * @param $value
      * @param null $ttl
      *

src/Command/GenerateSpecCommand.php

Doc Comments +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
     }
 
     /**
-     * @param $buildVersion
+     * @param string $buildVersion
      * @param $upgradeTo
      */
     private function validateVersion($buildVersion, $upgradeTo)

src/Data/Manager.php

Doc Comments +3 added lines, -3 removed lines

@@ -43,7 +43,7 @@ 
      *
      * Examples: 7.6.1 -> 7.6.1.0, 7.7 -> 7.7.1, 7.8 -> 7.8.0.0
      *
-     * @param $flav
+     * @param string $flav
      * @param null $baseVersion
      *
      * @return mixed
@@ -99,7 +99,7 @@ 
     /**
      * Gets all required information to perform health check.
      *
-     * @param $version
+     * @param string $version
      *
      * @return mixed
      */
@@ -111,7 +111,7 @@ 
     /**
      * Gets all required information to perform upgrade.
      *
-     * @param $version
+     * @param string $version
      *
      * @return mixed
      */

src/Data/Provider/Memory.php

Doc Comments +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
     /**
      * Gets data from memory by key.
      *
-     * @param $key
+     * @param string $key
      * @param null $default
      *
      * @return mixed|null

src/Element/Section/UpgradeChanges.php

Doc Comments +5 added lines, -6 removed lines

@@ -54,8 +54,7 @@ 
     /**
      * Get all available SugarCRM versions (sorted ASC).
      *
-     * @param mixed $flav
-     * @param mixed $pathToUpgradePackage
+     * @param Context $pathToUpgradePackage
      *
      * @return mixed
      */
@@ -75,7 +74,7 @@ 
      *
      * @param string $pathToUpgradePackage
      *
-     * @return mixed
+     * @return string
      */
     public function getListOfDeletedFiles($pathToUpgradePackage)
     {
@@ -87,7 +86,7 @@ 
      *
      * @param string $pathToUpgradePackage
      *
-     * @return mixed
+     * @return string
      */
     public function getListOfModifiedFiles($pathToUpgradePackage)
     {
@@ -99,7 +98,7 @@ 
      *
      * @param string $pathToUpgradePackage
      *
-     * @return mixed
+     * @return string
      */
     public function getListOfScripts($pathToUpgradePackage)
     {
@@ -111,7 +110,7 @@ 
      *
      * @param string $pathToUpgradePackage
      *
-     * @return mixed
+     * @return string
      */
     public function getListOfSQLScripts($pathToUpgradePackage)
     {

src/Updater/Adapter/HumbugAdapter.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
     }
 
     /**
-     * @param $stability
+     * @param string $stability
      *
      * @return string
      */

src/Data/DataAwareInterface.php

Doc Comments +3 added lines

@@ -4,5 +4,8 @@
 
 interface DataAwareInterface
 {
+    /**
+     * @return void
+     */
     public function setDataManager(Manager $dataManager);
 }

src/Formatter/FormatterInterface.php

Doc Comments +9 added lines

@@ -4,9 +4,18 @@
 
 interface FormatterInterface
 {
+    /**
+     * @return string
+     */
     public function asTitle($text, $level = 1);
 
+    /**
+     * @return string
+     */
     public function asBody($text);
 
+    /**
+     * @return string
+     */
     public function getDelimiter();
 }