nozavroni / csvelte

src/CSVelte/Taster.php

Doc Comments +5 added lines, -1 removed lines

@@ -189,6 +189,7 @@ 
      * replaceQuotedSpecialChars method which (at least to me) makes more sense.
      *
      * @param string The string to replace quoted strings within
+     * @param string $data
      * @return string The input string with quoted strings removed
      * @todo Replace code that uses this method with the replaceQuotedSpecialChars
      *     method instead. I think it's cleaner.
@@ -559,7 +560,7 @@ 
      * Determine whether a particular string of data has quotes around it.
      *
      * @param string The data to check
-     * @return boolean Whether the data is quoted or not
+     * @return integer Whether the data is quoted or not
      */
     protected function isQuoted($data)
     {
@@ -607,6 +608,8 @@ 
      *
      * @param string The string to do the replacements on
      * @param string The delimiter character to replace
+     * @param string $data
+     * @param string $delim
      * @return string The data with replacements performed
      * @todo I could probably pass in (maybe optionally) the newline character I
      *     want to replace as well. I'll do that if I need to.
@@ -632,6 +635,7 @@ 
      * to be practical.
      *
      * @param string The string of data to check the type of
+     * @param string $data
      * @return string One of the TYPE_ string constants above
      */
     protected function lickType($data)

src/CSVelte/IO/BufferStream.php

Doc Comments +2 added lines, -2 removed lines

@@ -119,7 +119,7 @@ 
      * Read in the specified amount of characters from the input source
      *
      * @param integer Amount of characters to read from input source
-     * @return string|boolean The specified amount of characters read from input source
+     * @return false|string The specified amount of characters read from input source
      */
     public function read($chars)
     {
@@ -246,7 +246,7 @@ 
      *
      * After the stream has been detached, the stream is in an unusable state.
      *
-     * @return BufferStream|null Underlying PHP stream, if any
+     * @return string Underlying PHP stream, if any
      */
     public function detach()
     {

src/CSVelte/IO/Stream.php

Doc Comments +4 added lines, -3 removed lines

@@ -131,6 +131,7 @@ 
      *
      * @see http://php.net/manual/en/function.fopen.php
      * @see http://php.net/manual/en/function.stream-context-create.php
+     * @param string $mode
      */
     public static function open($uri, $mode = null, $context = null, $lazy = false)
     {
@@ -143,7 +144,7 @@ 
     /**
      * Close stream resource.
      *
-     * @return boolean True on success or false on failure
+     * @return boolean|null True on success or false on failure
      */
     public function close()
     {
@@ -224,7 +225,7 @@ 
      *
      * Returns the internal stream resource pointer
      *
-     * @return resource The open stream resource pointer
+     * @return Resource The open stream resource pointer
      */
     public function getResource()
     {
@@ -262,7 +263,7 @@ 
      *
      * After the stream has been detached, the stream is in an unusable state.
      *
-     * @return Resource|null Underlying PHP stream, if any
+     * @return Resource Underlying PHP stream, if any
      */
     public function detach()
     {

src/CSVelte/IO/Resource.php

Doc Comments +3 added lines, -1 removed lines

@@ -233,7 +233,7 @@ 
      *
      * Creates and returns a Stream object for this resource
      *
-     * @return resource The underlying stream resource
+     * @return Stream The underlying stream resource
      */
     public function __invoke()
     {
@@ -853,6 +853,7 @@ 
      * only be called on unopened stream resources.
      *
      * @param  string The method that is asserting
+     * @param string $method
      * @return void
      * @throws \CSVelte\Exception\IOException if stream is open
      */
@@ -869,6 +870,7 @@ 
      * Used internally to ensure that a given stream wrapper is valid and available
      *
      * @param  string The name of the stream wrapper
+     * @param string $name
      * @return void
      * @throws \InvalidArgumentException if wrapper doesn't exist
      */