mkungla / libhowi-filesystem

Commons/ObjectInterfaces/FileInterface.inc

Doc Comments +5 added lines, -9 removed lines

@@ -49,6 +49,7 @@ 
     /**
      * Assert that if some wierd reason this is called in file
      * that we return false
+     * @return boolean
      */
     public function getLinkTarget();
 
@@ -82,6 +83,7 @@ 
      * No purpose
      * inherited from iterator but useless
      * An FileObject does not have children so this method returns allways NULL.
+     * @return boolean
      */
     public function getChildren();
 
@@ -90,7 +92,7 @@ 
      *
      * Forces a write of all buffered output to the file.
      *
-     * @return Returns TRUE on success or FALSE on failure
+     * @return boolean TRUE on success or FALSE on failure
      */
     public function fflush();
 
@@ -146,14 +148,8 @@ 
      *
      * @param array $fields
      *            An array of values.
-     * @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
-     *            The optional escape parameter sets the escape character (one character only).
      *            
-     * @return int|bool Returns the length of the written string or FALSE on failure.
+     * @return integer Returns the length of the written string or FALSE on failure.
      *         returns FALSE, and does not write the CSV line to the file, if the delimiter
      *         or enclosure parameter is not a single character.
      *        
@@ -313,7 +309,7 @@ 
      * FileObject::setMaxLineLen() is used to read fixed lengths of the file.
      *
      *
-     * @return Returns the current line number.
+     * @return integer the current line number.
      */
     public function key();
 

Commons/ObjectInterfaces/InfoInterface.inc

Doc Comments +1 added lines

@@ -37,6 +37,7 @@
      * Gets an InfoObject object for the file
      *
      * @param string $class_name            
+     * @return \SplFileInfo
      */
     public function getFileInfo($class_name = '\HOWI3\libhowi\Filesystem\php5\Objects\InfoObject');
 }

Commons/ObjectInterfaces/LinkInterface.inc

Doc Comments +3 added lines

@@ -28,6 +28,7 @@ 
 
     /**
      * symlink — Creates a symbolic link
+     * @return boolean
      */
     public function symlink($target = false, $link = false);
 
@@ -43,6 +44,7 @@ 
 
     /**
      * link — Create a hard link
+     * @return boolean
      */
     public function hardlink($target = false, $link = false);
 
@@ -68,6 +70,7 @@ 
 
     /**
      * readlink — Returns the target of a symbolic link
+     * @return false|string
      */
     public function readlink($link = false);
 }

Commons/ObjectInterfaces/TmpInterface.inc

Doc Comments +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
     /**
      * tmpfile — Creates a temporary file
      * 
-     * @return filehandler
+     * @return resource
      */
     public function tmpfile();
 }

Commons/ResponseObject.inc

Doc Comments +15 added lines

@@ -72,21 +72,33 @@ 
     private $level;
 
 
+    /**
+     * @param boolean $arg
+     */
     public function setStatus($arg)
     {
         $this->status = is_bool($arg) ? $arg : false;
     }
 
+    /**
+     * @param integer $code
+     */
     public function setCode($code)
     {
         $this->code = is_int($code) ? $code : 0;
     }
 
+    /**
+     * @param string $msg
+     */
     public function setMsg($msg)
     {
         $this->message = is_string($msg) ? $msg : 'BUG';
     }
 
+    /**
+     * @param integer $UID
+     */
     public function setUID($UID)
     {
         $this->UID = is_int($UID) ? $UID : 'BUG';
@@ -102,6 +114,9 @@ 
         $this->microtime = microtime(true);
     }
 
+    /**
+     * @param string $context
+     */
     public function setContext($context)
     {
         $this->context = $context;

Commons/SharedMethodsInterface.inc

Doc Comments +3 added lines, -3 removed lines

@@ -46,7 +46,6 @@ 
      * Gets last access time of file
      *
      * @param string $timeformat            
-     * @param string $filename            
      * @return int or formated output
      */
     public function getATime($timeformat = false, $pathname = false);
@@ -55,7 +54,6 @@ 
      * Gets inode change time of file
      *
      * @param string $timeformat            
-     * @param string $filename            
      * @return int or formated output
      */
     public function getCTime($timeformat = false, $pathname = false);
@@ -64,7 +62,6 @@ 
      * Gets file modification time
      *
      * @param string $timeformat            
-     * @param string $filename            
      * @return int or formated output
      */
     public function getMTime($timeformat = false, $pathname = false);
@@ -81,6 +78,7 @@ 
      *            ommit emty values?
      * @param string $ago_single            
      * @param array $clocale            
+     * @return string
      */
     public function ct_ago($timestamp, $date_format = 'y,m,d,h,i,s', $sfx = true, $ommit_zero = true, $ago_single = true, $clocale = []);
 
@@ -101,6 +99,7 @@ 
      * Sets the class used with InfoObject::openFile()
      *
      * @param string $class_name            
+     * @return boolean
      */
     public function setFileClass($class_name = "\HOWI3\libhowi\Filesystem\php5\Objects\FileObject");
 
@@ -108,6 +107,7 @@ 
      * Sets the class used with InfoObject::getFileInfo() and SplFileInfo::getPathInfo()
      *
      * @param string $class_name            
+     * @return boolean
      */
     public function setInfoClass($class_name = "\HOWI3\libhowi\Filesystem\php5\Objects\InfoObject");