Better comments
authorRoland Häder <roland@mxchange.org>
Tue, 25 Sep 2012 21:33:39 +0000 (21:33 +0000)
committerRoland Häder <roland@mxchange.org>
Tue, 25 Sep 2012 21:33:39 +0000 (21:33 +0000)
inc/classes/main/io/class_FrameworkFileOutputPointer.php

index 0d13365..21e82ba 100644 (file)
@@ -93,7 +93,7 @@ class FrameworkFileOutputPointer extends BaseFrameworkSystem {
         * Write data to a file pointer
         *
         * @param       $dataStream             The data stream we shall write to the file
-        * @return      mixed                   The result of fwrite()
+        * @return      mixed                   Number of writes bytes or FALSE on error
         * @throws      NullPointerException    If the file pointer instance
         *                                                                      is not set by setPointer()
         * @throws      InvalidResourceException        If there is being set
@@ -108,7 +108,7 @@ class FrameworkFileOutputPointer extends BaseFrameworkSystem {
                        throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
                }
 
-               // Read data from the file pointer and return it
+               // Write data to the file pointer and return written bytes
                return fwrite($this->getPointer(), $dataStream);
        }