@@ -43,13 +43,13 @@ |
||
| 43 | 43 | |
| 44 | 44 | use GanbaroDigital\MissingBits\TraceInspectors\GetCaller; |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * work out who has called a piece of code |
|
| 48 | - * |
|
| 49 | - * @param array $filterList |
|
| 50 | - * a list of namespaces and classes to skip over |
|
| 51 | - * @return StackFrame |
|
| 52 | - */ |
|
| 46 | + /** |
|
| 47 | + * work out who has called a piece of code |
|
| 48 | + * |
|
| 49 | + * @param array $filterList |
|
| 50 | + * a list of namespaces and classes to skip over |
|
| 51 | + * @return StackFrame |
|
| 52 | + */ |
|
| 53 | 53 | function get_caller(array $filterList = []) |
| 54 | 54 | { |
| 55 | 55 | // we supply the trace |
@@ -59,7 +59,7 @@ |
||
| 59 | 59 | * |
| 60 | 60 | * @param mixed $item |
| 61 | 61 | * the item to examine |
| 62 | - * @return array |
|
| 62 | + * @return string[] |
|
| 63 | 63 | * the list of type(s) that this item can be |
| 64 | 64 | */ |
| 65 | 65 | public function __invoke($item) |
@@ -45,17 +45,17 @@ |
||
| 45 | 45 | use GanbaroDigital\MissingBits\ListTraversals\TraverseList; |
| 46 | 46 | use GanbaroDigital\MissingBits\ListTraversals\TraverseObject; |
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * traverse a list held in an array |
|
| 50 | - * |
|
| 51 | - * @param array $list |
|
| 52 | - * the list to walk |
|
| 53 | - * @param string $listName |
|
| 54 | - * what is the name of $list in the calling code? |
|
| 55 | - * @param callable $callable |
|
| 56 | - * what are we calling |
|
| 57 | - * @return void |
|
| 58 | - */ |
|
| 48 | + /** |
|
| 49 | + * traverse a list held in an array |
|
| 50 | + * |
|
| 51 | + * @param array $list |
|
| 52 | + * the list to walk |
|
| 53 | + * @param string $listName |
|
| 54 | + * what is the name of $list in the calling code? |
|
| 55 | + * @param callable $callable |
|
| 56 | + * what are we calling |
|
| 57 | + * @return void |
|
| 58 | + */ |
|
| 59 | 59 | function traverse_array($list, $listName, callable $callable) |
| 60 | 60 | { |
| 61 | 61 | return TraverseArray::using($list, $listName, $callable); |
@@ -57,7 +57,7 @@ |
||
| 57 | 57 | * @param int $filter |
| 58 | 58 | * the kind of properties to look for |
| 59 | 59 | * default is to look for public properties only |
| 60 | - * @return array |
|
| 60 | + * @return boolean |
|
| 61 | 61 | * a (possibly empty) read-only list of the object's |
| 62 | 62 | * non-static properties |
| 63 | 63 | * @throws InvalidArgumentException |
@@ -57,7 +57,7 @@ |
||
| 57 | 57 | * @param int $filter |
| 58 | 58 | * the kind of properties to look for |
| 59 | 59 | * default is to look for public properties only |
| 60 | - * @return array |
|
| 60 | + * @return boolean |
|
| 61 | 61 | * a (possibly empty) read-only list of the object's |
| 62 | 62 | * non-static properties |
| 63 | 63 | * @throws InvalidArgumentException |
@@ -90,8 +90,6 @@ |
||
| 90 | 90 | /** |
| 91 | 91 | * is $item something that PHP will accept as a string? |
| 92 | 92 | * |
| 93 | - * @param mixed $item |
|
| 94 | - * the variable to examine |
|
| 95 | 93 | * @return boolean |
| 96 | 94 | * TRUE if PHP will happily use $item as a string |
| 97 | 95 | * FALSE otherwise |