nozavroni / csvelte

src/CSVelte/Flavor.php

Doc Comments +1 added lines, -1 removed lines

@@ -204,7 +204,7 @@
      * instead, specifying which attributes are to be changed.
      *
      * @param array An array of attribute name/values to change in the copied flavor
-     * @return CSVelte\Flavor A flavor object with your new attributes
+     * @return Flavor A flavor object with your new attributes
      * @access public
      * @todo I may want to remove the array type-hint so that this can accept
      *     array-like objects and iterables as well. Not sure...

Unused Use Statements -1 removed lines

@@ -14,7 +14,6 @@
 namespace CSVelte;
 
 use CSVelte\Exception\UnknownAttributeException;
-use CSVelte\Exception\UnknownFlavorException;
 use CSVelte\Exception\ImmutableException;
 
 /**

src/CSVelte/Input/SeekableStream.php

Unused Use Statements -1 removed lines

@@ -12,7 +12,6 @@
  */
 namespace CSVelte\Input;
 
-use CSVelte\Contract\Readable;
 use CSVelte\Contract\Seekable;
 
 /**

src/CSVelte/Input/Stream.php

Unused Use Statements -1 removed lines

@@ -17,7 +17,6 @@
 use CSVelte\Exception\EndOfFileException;
 use CSVelte\Traits\HandlesQuotedLineTerminators;
 use CSVelte\Exception\InvalidStreamResourceException;
-use CSVelte\Exception\InvalidStreamUriException;
 
 /**
  * CSVelte\Input\Stream

src/CSVelte/Reader.php

Doc Comments +1 added lines

@@ -212,6 +212,7 @@
      * Remove quotes wrapping text.
      *
      * @param string The data to unquote
+     * @param string|null $data
      * @return string The data with quotes stripped from the outside of it
      * @internal
      */

src/CSVelte/Table/AbstractRow.php

Doc Comments +1 added lines, -1 removed lines

@@ -173,7 +173,7 @@
     /**
      * Return the internal pointer to the first column and return that object
      *
-     * @return void
+     * @return CSVelte\Table\Data|null
      * @access public
      */
     public function rewind()

src/CSVelte/Taster.php

Doc Comments +10 added lines, -4 removed lines

@@ -126,7 +126,7 @@ 
     /**
      * I'm not sure what this is for...
      * @param  Readable $input The input source
-     * @return CSVelte\Taster
+     * @return Taster
      * @todo Get rid of this unless there is a good reason for having it...?
      * @ignore
      */
@@ -142,7 +142,7 @@ 
      * such as the delimiting character, quote character, or what types of data are quoted.
      * are quoted.
      *
-     * @return CSVelte\Flavor The metadata that the CSV format doesn't provide
+     * @return Flavor The metadata that the CSV format doesn't provide
      * @access public
      * @todo Implement a lickQuote method for when lickQuoteAndDelim method fails
      * @todo Should there bea lickEscapeChar method? the python module that inspired
@@ -175,6 +175,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
      * @access protected
      * @todo Replace code that uses this method with the replaceQuotedSpecialChars
@@ -189,7 +190,7 @@ 
      * Examine the input source to determine which character(s) are being used
      * as the end-of-line character
      *
-     * @return char The end-of-line char for the input data
+     * @return string The end-of-line char for the input data
      * @access protected
      * @credit pulled from stackoverflow thread *tips hat to username "Harm"*
      * @todo This should throw an exception if it cannot determine the line ending
@@ -333,6 +334,8 @@ 
      * @param char The type of quote character being used (single or double)
      * @param char The character used as the column delimiter
      * @param char The character used for newlines
+     * @param string $data
+     * @param string $eol
      * @return string One of four "QUOTING_" constants defined above--see this
      *     method's description for more info.
      * @access protected
@@ -419,7 +422,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
      * @access protected
      */
     protected function isQuoted($data)
@@ -495,6 +498,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
      * @access protected
      * @uses Carbon/Carbon date/time ilbrary/class
@@ -554,6 +558,8 @@ 
      * @param char The CSV data's delimiting char (can be a variety of chars but)
      *     typically is either a comma or a tab, sometimes a pipe)
      * @param char The CSV data's end-of-line char(s) (\n \r or \r\n)
+     * @param string $data
+     * @param string $eol
      * @return boolean True if the data (most likely) contains a header row
      * @access public
      * @todo This method needs a total refactor. It's not necessary to loop twice

src/CSVelte/Writer.php

Doc Comments +3 added lines, -3 removed lines

@@ -86,7 +86,7 @@ 
      * likely buffer the output so that this may be called after writeRows()
      *
      * @param \Iterator|array A list of header values
-     * @return boolean
+     * @return boolean|null
      * @throws CSVelte\Exception\WriteBufferException
      */
     public function setHeaderRow($headers)
@@ -152,7 +152,7 @@ 
      * This means taking an array of data, and converting it to a Row object
      *
      * @param \Iterator|array of data items
-     * @return CSVelte\Table\AbstractRow
+     * @return Row
      * @access protected
      */
     protected function prepareRow(\Iterator $row)
@@ -169,7 +169,7 @@ 
      * Prepare a cell of data to be written (convert to Data object)
      *
      * @param mixed Any value that can be converted to a CSVelte\Table\Data object
-     * @return CSVelte\Table\Data
+     * @return string
      * @access protected
      */
     protected function prepareData($data)