nozavroni / csvelte

src/CSVelte/Taster.php

Doc Comments +10 added lines, -4 removed lines

@@ -130,7 +130,7 @@ 
      *
      * @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
@@ -147,7 +147,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
      *
      * @todo Implement a lickQuote method for when lickQuoteAndDelim method fails
      * @todo Should there bea lickEscapeChar method? the python module that inspired
@@ -181,6 +181,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
      *
@@ -196,7 +197,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
      * @credit pulled from stackoverflow thread *tips hat to username "Harm"*
      *
      * @todo This should throw an exception if it cannot determine the line ending
@@ -349,6 +350,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.
@@ -447,7 +450,7 @@ 
      *
      * @param string The data to check
      *
-     * @return bool Whether the data is quoted or not
+     * @return integer Whether the data is quoted or not
      */
     protected function isQuoted($data)
     {
@@ -526,6 +529,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
      *
@@ -587,6 +591,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 bool True if the data (most likely) contains a header row
      *

src/CSVelte/Writer.php

Doc Comments +3 added lines, -3 removed lines

@@ -90,7 +90,7 @@ 
      *
      * @throws CSVelte\Exception\WriteBufferException
      *
-     * @return bool
+     * @return boolean|null
      */
     public function setHeaderRow($headers)
     {
@@ -166,7 +166,7 @@ 
      *
      * @param \Iterator|array of data items
      *
-     * @return CSVelte\Table\AbstractRow
+     * @return Row
      */
     protected function prepareRow(\Iterator $row)
     {
@@ -184,7 +184,7 @@ 
      *
      * @param mixed Any value that can be converted to a CSVelte\Table\Data object
      *
-     * @return CSVelte\Table\Data
+     * @return string
      */
     protected function prepareData($data)
     {