allejo / PhpPulse

src/PulseColumn.php

Doc Comments +3 added lines

@@ -69,6 +69,9 @@
         $this->deletedObject = true;
     }
 
+    /**
+     * @param string $field
+     */
     private function editField ($field, $value)
     {
         $this->checkInvalid();

src/Utilities/UrlQuery.php

Doc Comments +1 added lines, -1 removed lines

@@ -233,7 +233,7 @@
      *
      * @throws \allejo\DaPulse\Exceptions\CurlException If cURL is misconfigured or encounters an error
      *
-     * @return mixed
+     * @return string
      */
     private function executeCurl ()
     {

src/PulseNote.php

Doc Comments +2 added lines, -2 removed lines

@@ -106,7 +106,7 @@ 
      *
      * @since  0.1.0
      *
-     * @return string
+     * @return integer
      */
     public function getId ()
     {
@@ -212,7 +212,7 @@ 
      *
      * @param  null|string        $title        The new title of the note
      * @param  null|string        $content      The new content of the note
-     * @param  null|int|PulseUser $user         The new author of the note
+     * @param  string $user         The new author of the note
      * @param  null|bool          $createUpdate Whether to create an update or not
      *
      * @since  0.1.0

src/PulseUpdate.php

Doc Comments +3 added lines, -3 removed lines

@@ -135,7 +135,7 @@ 
      *
      * @since  0.1.0
      *
-     * @return string
+     * @return integer
      */
     public function getId ()
     {
@@ -323,7 +323,7 @@ 
      *
      * @since  0.3.0 Previously was available as 'getHasAssets()'
      *
-     * @return bool
+     * @return string
      */
     public function hasAssets ()
     {
@@ -477,7 +477,7 @@ 
      * @api
      *
      * @param  int|PulseUser $user          The author of this post
-     * @param  int|Pulse     $pulse         The Pulse to whom this update will belong to
+     * @param  integer     $pulse         The Pulse to whom this update will belong to
      * @param  string        $text          The content of the update
      * @param  null|bool     $announceToAll Whether or not to announce this update to everyone's wall
      *

docs/sami-config.php

Braces +2 added lines, -1 removed lines

@@ -32,7 +32,8 @@
  * Include this section if you want sami to document
  * private and protected functions/properties
  */
-$sami['filter'] = function () {
+$sami['filter'] = function ()
+{
     return new ApiFilter();
 };
 

src/Objects/PulseColumnStatusValue.php

Doc Comments +1 added lines, -1 removed lines

@@ -171,7 +171,7 @@
      *
      * @since  0.3.1
      *
-     * @return array
+     * @return string[]
      */
     public static function getHexColors ()
     {

src/Objects/SubscribableObject.php

Doc Comments +2 added lines, -2 removed lines

@@ -70,7 +70,7 @@ 
      *
      * @api
      *
-     * @param  int|PulseUser $userId  The user that will be subscribed to the board
+     * @param  integer $userId  The user that will be subscribed to the board
      * @param  bool|null     $asAdmin Set to true if the user will be an admin of the board
      *
      * @since  0.3.0 A PulseUser object of the newly added subscriber is returned
@@ -106,7 +106,7 @@ 
      *
      * @api
      *
-     * @param  int|PulseUser $userId The user that will be unsubscribed from the board
+     * @param  integer $userId The user that will be unsubscribed from the board
      *
      * @since  0.3.0 A PulseUser object of the removed subscriber is returned
      * @since  0.1.0

src/PulseBoard.php

Doc Comments +2 added lines, -2 removed lines

@@ -396,7 +396,7 @@ 
      * @api
      *
      * @param string        $name          The name of the Pulse
-     * @param PulseUser|int $user          The owner of the Pulse, i.e. who created it
+     * @param integer $user          The owner of the Pulse, i.e. who created it
      * @param string|null   $groupId       The group to add this Pulse to
      * @param string|null   $updateText    The update's text, can contain simple HTML for formatting
      * @param bool|null     $announceToAll Determines if the update should be sent to everyone's wall
@@ -466,7 +466,7 @@ 
      * @api
      *
      * @param  string        $name        The name of the board
-     * @param  int|PulseUser $user        The owner of the board
+     * @param  integer $user        The owner of the board
      * @param  string|null   $description A description of the board
      *
      * @since  0.3.0 $userId may be a PulseUser object and \InvalidArgumentException is now thrown