Permalink
Browse files

Fixing comments

  • Loading branch information...
1 parent 8fcb0ae commit 4753550af617e4ba3600a448a4977541a2a6c395 @chdemko committed Jun 24, 2012
@@ -76,7 +76,7 @@ public static function read($name, $args)
* @param string $name The writer name.
* @param array $args Array of args
*
- * @return int|FALSE The number of bytes written, or FALSE on failure.
+ * @return mixed The number of bytes written, or FALSE on failure.
*
* @since 12.2
*/
@@ -106,7 +106,7 @@ public static function pull($name, $args)
* @param string $name The pusher name.
* @param array $args Array of args
*
- * @return int|FALSE The number of bytes written, or FALSE on failure.
+ * @return mixed The number of bytes written, or FALSE on failure.
*
* @since 12.2
*/
@@ -25,7 +25,7 @@
*
* @param JFilesystemElementFile $file The file to be read.
*
- * @return string|FALSE The character read, or FALSE on failure.
+ * @return mixed The character read, or FALSE on failure.
*
* @link http://php.net/manual/en/function.fgetc.php
*
@@ -42,7 +42,7 @@ public static function read(JFilesystemElementFile $file)
* @param JFilesystemElementFile $file The file to be written.
* @param string $character The character that is to be written.
*
- * @return int|FALSE The number of bytes written, or FALSE on failure.
+ * @return mixed The number of bytes written, or FALSE on failure.
*
* @see JFilesystemAccessorContents::write
*
@@ -24,9 +24,9 @@
* Read data from a file
*
* @param JFilesystemElementFile $file The file to be read.
- * @param int $length The maximum number of characters read.
+ * @param integer $length The maximum number of characters read.
*
- * @return string|FALSE The data read, or FALSE on failure.
+ * @return mixed The data read, or FALSE on failure.
*
* @link http://php.net/manual/en/function.fread.php
*
@@ -42,9 +42,9 @@ public static function read(JFilesystemElementFile $file, $length)
*
* @param JFilesystemElementFile $file The file to be written.
* @param string $data The string that is to be written.
- * @param int $length The maximum number of characters written.
+ * @param integer $length The maximum number of characters written.
*
- * @return int|FALSE The number of bytes written, or FALSE on failure.
+ * @return mixed The number of bytes written, or FALSE on failure.
*
* @link http://php.net/manual/en/function.fwrite.php
*
@@ -66,10 +66,10 @@ public static function write(JFilesystemElementFile $file, $data, $length = null
* Pull an entire file into a string
*
* @param JFilesystemElementFile $file The file to be pulled.
- * @param int $offset The offset where the reading starts on the original stream.
- * @param int $maxlen Maximum length of data read.
+ * @param integer $offset The offset where the reading starts on the original stream.
+ * @param integer $maxlen Maximum length of data read.
*
- * @return string|FALSE The read data or FALSE on failure.
+ * @return mixed The read data or FALSE on failure.
*
* @link http://php.net/manual/en/function.file-get-contents.php
*
@@ -92,11 +92,11 @@ public static function pull(JFilesystemElementFile $file, $offset = -1, $maxlen
*
* @param JFilesystemElementFile $file The file to be pushed.
* @param mixed $data The data to write. Can be either a string, an array or a stream resource.
- * @param int $flags The value of flags can be any combination of the following flags, joined with the binary | operator:
+ * @param integer $flags The value of flags can be any combination of the following flags, joined with the binary | operator:
* -FILE_APPEND If file filename already exists, append the data to the file instead of overwriting it.
* -LOCK_EX Acquire an exclusive lock on the file while proceeding to the writing.
*
- * @return int|FALSE The number of bytes that were written to the file, or FALSE on failure.
+ * @return mixed The number of bytes that were written to the file, or FALSE on failure.
*
* @link http://php.net/manual/en/function.file-put-contents.php
*
@@ -24,12 +24,12 @@
* Read csv data from a file
*
* @param JFilesystemElementFile $file The file to be read.
- * @param int $length The longest line (in characters) to be found in the CSV file.
+ * @param integer $length The longest line (in characters) to be found in the CSV file.
* @param string $delimiter The optional delimiter parameter sets the field delimiter (one character only).
* @param string $enclosure The optional enclosure parameter sets the field enclosure (one character only).
* @param string $escape Set the escape character (one character only).
*
- * @return array|FALSE|NULL The data read, or FALSE or NULL on failure.
+ * @return mixed The data read, or FALSE or NULL on failure.
*
* @link http://php.net/manual/en/function.fgetcsv.php
*
@@ -48,7 +48,7 @@ public static function read(JFilesystemElementFile $file, $length = 0, $delimite
* @param string $delimiter The optional delimiter parameter sets the field delimiter (one character only).
* @param string $enclosure The optional enclosure parameter sets the field enclosure (one character only).
*
- * @return int|FALSE The number of bytes written, or FALSE on failure.
+ * @return mixed The number of bytes written, or FALSE on failure.
*
* @link http://php.net/manual/en/function.fputcsv.php
*
@@ -63,12 +63,12 @@ public static function write(JFilesystemElementFile $file, $fields, $delimiter =
* Pull csv data from a file
*
* @param JFilesystemElementFile $file The file to be read.
- * @param int $length The longest line (in characters) to be found in the CSV file.
+ * @param integer $length The longest line (in characters) to be found in the CSV file.
* @param string $delimiter The optional delimiter parameter sets the field delimiter (one character only).
* @param string $enclosure The optional enclosure parameter sets the field enclosure (one character only).
* @param string $escape Set the escape character (one character only).
*
- * @return array|FALSE The csv data, or FALSE on failure.
+ * @return mixed The csv data, or FALSE on failure.
*
* @link http://php.net/manual/en/function.fgetcsv.php
*
@@ -93,11 +93,11 @@ public static function pull(JFilesystemElementFile $file, $length = 0, $delimite
* Push csv data to a file
*
* @param JFilesystemElementFile $file The file to be written.
- * @param Traversable|array $data The csv data that is to be written.
+ * @param mixed $data The csv data that is to be written.
* @param string $delimiter The optional delimiter parameter sets the field delimiter (one character only).
* @param string $enclosure The optional enclosure parameter sets the field enclosure (one character only).
*
- * @return int|FALSE The number of bytes written, or FALSE on failure.
+ * @return mixed The number of bytes written, or FALSE on failure.
*
* @link http://php.net/manual/en/function.fputcsv.php
*
@@ -26,7 +26,7 @@
* @param JFilesystemElementFile $file The file to be read.
* @param string $format The format string.
*
- * @return array|FALSE The data read, or FALSE on failure.
+ * @return mixed The data read, or FALSE on failure.
*
* @link http://php.net/manual/en/function.fscanf.php
*
@@ -43,7 +43,7 @@ public static function read(JFilesystemElementFile $file, $format)
* @param JFilesystemElementFile $file The file to be written.
* @param string $format The format string.
*
- * @return int|FALSE The number of bytes written, or FALSE on failure.
+ * @return mixed The number of bytes written, or FALSE on failure.
*
* @link http://php.net/manual/en/function.fwrite.php
*
@@ -24,11 +24,11 @@
* pull entire ini file into an array
*
* @param JFilesystemElementFile $file The file to be read.
- * @param bool $process_sections Tells to get a multidimensional array, with the section names and settings included.
- * @param int $scanner_mode Can either be INI_SCANNER_NORMAL (default) or INI_SCANNER_RAW.
+ * @param boolean $process_sections Tells to get a multidimensional array, with the section names and settings included.
+ * @param integer $scanner_mode Can either be INI_SCANNER_NORMAL (default) or INI_SCANNER_RAW.
* If INI_SCANNER_RAW is supplied, then option values will not be parsed.
*
- * @return array|FALSE Associative array on success, or FALSE on failure.
+ * @return mixed Associative array on success, or FALSE on failure.
*
* @link http://php.net/manual/en/function.parse-ini-file.php
*
@@ -43,9 +43,9 @@ public static function pull(JFilesystemElementFile $file, $process_sections = fa
* push an ini data to a file
*
* @param JFilesystemElementFile $file The file to be written.
- * @param Traversable|array $ini The ini to write.
+ * @param mixed $ini The ini to write.
*
- * @return int|FALSE The number of bytes that were written to the file, or FALSE on failure.
+ * @return mixed The number of bytes that were written to the file, or FALSE on failure.
*
* @see JFilesystemElementAccessorLine::write
*
@@ -108,7 +108,7 @@ public static function push(JFilesystemElementFile $file, $ini)
* @param string $key The ini key.
* @param mixed $value The ini value.
*
- * @return int|FALSE The number of bytes that were written to the file, or FALSE on failure.
+ * @return mixed The number of bytes that were written to the file, or FALSE on failure.
*
* @see JFilesystemElementAccessorLine::write
*
@@ -24,8 +24,8 @@
* Read a JSON value
*
* @param JFilesystemElementFile $file The file to be read.
- * @param bool $assoc When TRUE, returned objects will be converted into associative arrays.
- * @param int $depth User specified recursion depth.
+ * @param boolean $assoc When TRUE, returned objects will be converted into associative arrays.
+ * @param integer $depth User specified recursion depth.
*
* @return mixed Decoded JSON value.
*
@@ -53,12 +53,12 @@ public static function read(JFilesystemElementFile $file, $assoc = false, $depth
*
* @param JFilesystemElementFile $file The file to be written.
* @param mixed $value The value to write.
- * @param int $options Bitmask consisting of
+ * @param integer $options Bitmask consisting of
* JSON_HEX_QUOT, JSON_HEX_TAG, JSON_HEX_AMP, JSON_HEX_APOS, JSON_NUMERIC_CHECK, JSON_FORCE_OBJECT.
* JSON_NUMERIC_CHECK option was added in PHP 5.3.3
* JSON_BIGINT_AS_STRING, JSON_PRETTY_PRINT, JSON_UNESCAPED_SLASHES, JSON_UNESCAPED_UNICODE were added in PHP 5.4
*
- * @return int|FALSE The number of bytes that were written to the file, or FALSE on failure.
+ * @return mixed The number of bytes that were written to the file, or FALSE on failure.
*
* @link http://php.net/manual/en/function.json-encode.php
*
@@ -75,8 +75,8 @@ public static function write(JFilesystemElementFile $file, $value, $options = 0)
* Pull entire JSON file
*
* @param JFilesystemElementFile $file The file to be read.
- * @param bool $assoc When TRUE, returned objects will be converted into associative arrays.
- * @param int $depth User specified recursion depth.
+ * @param boolean $assoc When TRUE, returned objects will be converted into associative arrays.
+ * @param integer $depth User specified recursion depth.
*
* @return mixed Decoded JSON value.
*
@@ -103,13 +103,13 @@ public static function pull(JFilesystemElementFile $file, $assoc = false, $depth
* Push JSON data to a file
*
* @param JFilesystemElementFile $file The file to be written.
- * @param array|Traversable $data The value to write.
- * @param int $options Bitmask consisting of
+ * @param mixed $data The value to write.
+ * @param integer $options Bitmask consisting of
* JSON_HEX_QUOT, JSON_HEX_TAG, JSON_HEX_AMP, JSON_HEX_APOS, JSON_NUMERIC_CHECK, JSON_FORCE_OBJECT.
* JSON_NUMERIC_CHECK option was added in PHP 5.3.3
* JSON_BIGINT_AS_STRING, JSON_PRETTY_PRINT, JSON_UNESCAPED_SLASHES, JSON_UNESCAPED_UNICODE were added in PHP 5.4
*
- * @return int|FALSE The number of bytes that were written to the file, or FALSE on failure.
+ * @return mixed The number of bytes that were written to the file, or FALSE on failure.
*
* @link http://php.net/manual/en/function.file-put-contents.php
* @link http://php.net/manual/en/function.json-encode.php
@@ -24,9 +24,9 @@
* Read a line from a file
*
* @param JFilesystemElementFile $file The file to be read.
- * @param int $length The maximum number of characters read.
+ * @param integer $length The maximum number of characters read.
*
- * @return string|FALSE The data read, or FALSE on failure.
+ * @return mixed The data read, or FALSE on failure.
*
* @link http://php.net/manual/en/function.fgets.php
*
@@ -50,9 +50,9 @@ public static function read(JFilesystemElementFile $file, $length = null)
*
* @param JFilesystemElementFile $file The file to be written.
* @param string $data The string that is to be written.
- * @param int $length The maximum number of characters written.
+ * @param integer $length The maximum number of characters written.
*
- * @return int|FALSE The number of bytes written, or FALSE on failure.
+ * @return mixed The number of bytes written, or FALSE on failure.
*
* @see JFilesystemAccessorContents::write
*
@@ -74,9 +74,9 @@ public static function write(JFilesystemElementFile $file, $data, $length = null
* Pull lines from a file
*
* @param JFilesystemElementFile $file The file to be read.
- * @param int $length The maximum number of characters read.
+ * @param integer $length The maximum number of characters read.
*
- * @return array|FALSE The lines, or FALSE on failure.
+ * @return mixed The lines, or FALSE on failure.
*
* @since 12.2
*/
@@ -106,10 +106,10 @@ public static function pull(JFilesystemElementFile $file, $length = null)
* Push lines to a file
*
* @param JFilesystemElementFile $file The file to be written.
- * @param Traversable|array $data The data that is to be written.
- * @param int $length The maximum number of characters written.
+ * @param mixed $data The data that is to be written.
+ * @param integer $length The maximum number of characters written.
*
- * @return int|FALSE The number of bytes written, or FALSE on failure.
+ * @return mixed The number of bytes written, or FALSE on failure.
*
* @since 12.2
*/
@@ -52,7 +52,7 @@ public static function read(JFilesystemElementFile $file)
* @param JFilesystemElementFile $file The file to be written.
* @param mixed $serializable The data to be serialized.
*
- * @return int|FALSE The number of bytes written, or FALSE on failure.
+ * @return mixed The number of bytes written, or FALSE on failure.
*
* @link http://php.net/manual/en/function.serialize.php
*
@@ -93,9 +93,9 @@ public static function pull(JFilesystemElementFile $file)
* Push lines to a file
*
* @param JFilesystemElementFile $file The file to be written.
- * @param Traversable|array $data The data that is to be written.
+ * @param mixed $data The data that is to be written.
*
- * @return int|FALSE The number of bytes written, or FALSE on failure.
+ * @return mixed The number of bytes written, or FALSE on failure.
*
* @since 12.2
*/
@@ -25,11 +25,11 @@
*
* @param JFilesystemElementFile $file The file to be read.
* @param string $class_name Object class.
- * @param int $options Additional Libxml parameters. .
+ * @param integer $options Additional Libxml parameters. .
* @param string $ns Namespace prefix or URI.
- * @param bool $is_prefix TRUE if ns is a prefix, FALSE if it's a URI.
+ * @param boolean $is_prefix TRUE if ns is a prefix, FALSE if it's a URI.
*
- * @return JXMLElement|FALSE The xml or FALSE on failure.
+ * @return mixed The xml or FALSE on failure.
*
* @link http://php.net/manual/en/function.simplexml-load-file.php
*
@@ -46,7 +46,7 @@ public static function pull(JFilesystemElementFile $file, $class_name = 'SimpleX
* @param JFilesystemElementFile $file The file to be written.
* @param SimpleXMLElement $xml The xml to write.
*
- * @return int|FALSE The number of bytes that were written to the file, or FALSE on failure.
+ * @return mixed The number of bytes that were written to the file, or FALSE on failure.
*
* @link http://php.net/manual/en/function.file-put-contents.php
* @link http://php.net/manual/en/simplexmlelement.asxml.php
Oops, something went wrong.

0 comments on commit 4753550

Please sign in to comment.