ganbarodigital / php-the-missing-bits

src/list-functions.php

Indentation +11 added lines, -11 removed lines

@@ -45,17 +45,17 @@
 use GanbaroDigital\MissingBits\ListTraversals\TraverseList;
 use GanbaroDigital\MissingBits\ListTraversals\TraverseObject;
 
- /**
-  * traverse a list held in an array
-  *
-  * @param  array $list
-  *         the list to walk
-  * @param  string $listName
-  *         what is the name of $list in the calling code?
-  * @param  callable $callable
-  *         what are we calling
-  * @return void
-  */
+    /**
+     * traverse a list held in an array
+     *
+     * @param  array $list
+     *         the list to walk
+     * @param  string $listName
+     *         what is the name of $list in the calling code?
+     * @param  callable $callable
+     *         what are we calling
+     * @return void
+     */
 function traverse_array($list, $listName, callable $callable)
 {
     return TraverseArray::using($list, $listName, $callable);

src/type-functions.php

Doc Comments +3 added lines, -3 removed lines

@@ -543,7 +543,7 @@ 
 /**
  * is $item something that PHP will accept as a string?
  *
- * @param  mixed $item
+ * @param  string $item
  *         the variable to examine
  * @return bool
  *         TRUE if PHP will happily use $item as a string
@@ -652,7 +652,7 @@ 
 /**
  * what PHP type is $item?
  *
- * @param  mixed $item
+ * @param  string $item
  *         the data to examine
  * @param  int $flags
  *         options to change what we put in the return value
@@ -669,7 +669,7 @@ 
  *
  * @param  mixed $item
  *         the item to examine
- * @return array
+ * @return string[]
  *         the list of type(s) that this item can be
  */
 function get_strict_types($item)

src/TypeInspectors/GetDuckTypes.php

Doc Comments +1 added lines, -1 removed lines

@@ -194,7 +194,7 @@
      *
      * @param  mixed $item
      *         the item to examine
-     * @return array
+     * @return string[]
      *         the basic type of the examined item
      */
     private static function fromString($item)

src/trace-functions.php

Indentation +7 added lines, -7 removed lines

@@ -44,13 +44,13 @@
 use GanbaroDigital\MissingBits\TraceInspectors\GetCaller;
 use GanbaroDigital\MissingBits\TraceInspectors\StackFrame;
 
- /**
-  * work out who has called a piece of code
-  *
-  * @param  array $filterList
-  *         a list of namespaces and classes to skip over
-  * @return StackFrame
-  */
+    /**
+     * work out who has called a piece of code
+     *
+     * @param  array $filterList
+     *         a list of namespaces and classes to skip over
+     * @return StackFrame
+     */
 function get_caller(array $filterList = [])
 {
     // we supply the trace

src/error-shim.php

Doc Comments +24 added lines

@@ -57,13 +57,37 @@
      */
     interface Throwable
     {
+
+        /**
+         * @return string
+         */
         public function getMessage();
         public function getCode();
+
+        /**
+         * @return string
+         */
         public function getFile();
+
+        /**
+         * @return integer
+         */
         public function getLine();
         public function getTrace();
+
+        /**
+         * @return string
+         */
         public function getTraceAsString();
+
+        /**
+         * @return Exception
+         */
         public function getPrevious();
+
+        /**
+         * @return string
+         */
         public function __toString();
     }
 }

Indentation +3 added lines, -3 removed lines

@@ -69,9 +69,9 @@
 }
 
 if (!class_exists('Error')) {
-     /**
-     * taken from: http://php.net/manual/en/class.error.php
-     */
+        /**
+         * taken from: http://php.net/manual/en/class.error.php
+         */
     class Error extends Exception implements Throwable
     {
         public function __toString()