php-opencloud / openstack

src/Common/JsonPath.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
     /**
      * Set a node in the structure
      *
-     * @param $path  The XPath to use
+     * @param string $path  The XPath to use
      * @param $value The new value of the node
      */
     public function set($path, $value)

src/Common/Resource/HasWaiterTrait.php

Doc Comments +3 added lines, -3 removed lines

@@ -44,7 +44,7 @@ 
      *                              encapsulate your own logic to determine whether the resource has
      *                              successfully transitioned. When TRUE is returned by the callback,
      *                              the loop will end.
-     * @param int|bool $timeout     The maximum timeout in seconds. If the total time taken by the waiter has reached
+     * @param integer $timeout     The maximum timeout in seconds. If the total time taken by the waiter has reached
      *                              or exceed this timeout, the blocking operation will immediately cease. If FALSE
      *                              is provided, the timeout will never be considered.
      * @param int      $sleepPeriod The amount of time to pause between each HTTP request.
@@ -69,7 +69,7 @@ 
     /**
      * Internal method used to identify whether a timeout has been exceeded.
      *
-     * @param bool|int $timeout
+     * @param integer $timeout
      * @param int      $startTime
      *
      * @return bool
@@ -87,7 +87,7 @@ 
      * Convenience method providing a blocking operation until the resource transitions to an
      * ``ACTIVE`` status.
      *
-     * @param int|bool $timeout The maximum timeout in seconds. If the total time taken by the waiter has reached
+     * @param integer $timeout The maximum timeout in seconds. If the total time taken by the waiter has reached
      *                          or exceed this timeout, the blocking operation will immediately cease. If FALSE
      *                          is provided, the timeout will never be considered.
      */

src/Common/Resource/AbstractResource.php

Doc Comments +7 added lines, -1 removed lines

@@ -96,6 +96,9 @@ 
         }
     }
 
+    /**
+     * @param string $type
+     */
     private function parseDocBlockValue($type, $val)
     {
         if (strpos($type, '[]') === 0 && is_array($val)) {
@@ -120,6 +123,9 @@ 
         ]);
     }
 
+    /**
+     * @return string
+     */
     private function normalizeModelClass($class)
     {
         if (strpos($class, '\\') === false) {
@@ -166,7 +172,7 @@ 
     /**
      * @param array $definition
      *
-     * @return mixed
+     * @return ResponseInterface
      */
     public function executeWithState(array $definition)
     {

src/Common/Error/Builder.php

Doc Comments +5 added lines, -2 removed lines

@@ -44,7 +44,7 @@ 
     /**
      * Internal method used when outputting headers in the error description.
      *
-     * @param $name
+     * @param string $name
      *
      * @return string
      */
@@ -57,7 +57,7 @@ 
      * Before outputting custom links, it is validated to ensure that the user is not
      * directed off to a broken link. If a 404 is detected, it is hidden.
      *
-     * @param $link The proposed link
+     * @param string $link The proposed link
      *
      * @return bool
      */
@@ -107,6 +107,9 @@ 
         return $e;
     }
 
+    /**
+     * @param integer $statusCode
+     */
     private function getStatusCodeMessage($statusCode)
     {
         $errors = [

src/ObjectStore/v1/Models/Container.php

Doc Comments +1 added lines, -5 removed lines

@@ -140,7 +140,7 @@ 
      *
      * @param string $name The name of the object
      *
-     * @return Object
+     * @return \OpenStack\Common\Resource\ResourceInterface
      */
     public function getObject($name)
     {
@@ -188,10 +188,6 @@ 
      * allowing concatenation when a request is executed against the manifest.
      *
      * @param array  $data                     {@see \OpenStack\ObjectStore\v1\Api::putObject}
-     * @param int    $data['segmentSize']      The size in Bytes of each segment
-     * @param string $data['segmentContainer'] The container to which each segment will be uploaded
-     * @param string $data['segmentPrefix']    The prefix that will come before each segment. If omitted, a default
-     *                                         is used: name/timestamp/filesize
      *
      * @return Object
      */