Update the PHPDocs to modify the invalid types of parameters

git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@3272 bf3deb0d-5f1a-0410-827f-c0cc1f45334c

file.php

@@ -42,8 +42,8 @@ class file
   }
 
   /** Change the group for a file/dir...
-    * @param $filename string The file/directory to change
-    * @param $group mixed The group name or group GID
+    * @param string $filename The file/directory to change
+    * @param mixed $group The group name or group GID
     * @throws If filename not exists, or the directory is not RW
     */
   public function chgrp ($filename, $group)
@@ -65,7 +65,7 @@ class file
   }
 
   /** Change the rights mode for a file/dir...
-    * @param $filename string The file/directory to change
+    * @param string $filename The file/directory to change
     * @throws If filename not exists, or the directory is not RW
     */
   public function chmod ($filename, $mode)
@@ -87,8 +87,8 @@ class file
   }
 
   /** Change the owner for a file/dir...
-    * @param $filename string The file/directory to change
-    * @param $user mixed The user name or user UID
+    * @param string $filename The file/directory to change
+    * @param mixed $user The user name or user UID
     * @throws If filename not exists, or the directory is not RW
     */
   public function chown ($filename, $user)
@@ -116,7 +116,7 @@ class file
   }
 
   /** Chroot in the provided directory
-    * @param $directory string The directory to chroot
+    * @param string $directory The directory to chroot
     * @return true if the chroot is done, false if there is a failure
     * @throws If directory not exists, or the directory is not executable
     */
@@ -184,7 +184,7 @@ class file
   /** Write a string to a file
     * @param string $filename Path to the file where to write the data
     * @param string $data The data to write
-    * @param int|null $flags The optional flags
+    * @param integer|null $flags The optional flags
     * @return the length of the data stored
     * @throws If parent directory not exists, is not writeable, or the file
     *         exists and is not writeable
@@ -265,7 +265,7 @@ class file
 
 
   /** Lock a file exclusively
-    * @param $filename The file to lock
+    * @param string $filename The file to lock
     * @return bool true if the lock is acquired, false otherwise
     * @throws If parent directory not exists, or is not writeable
     */
@@ -287,7 +287,7 @@ class file
   }
 
   /** Lock a file shared (allow multiple read)
-    * @param $filename The file to lock
+    * @param string $filename The file to lock
     * @return bool true if the lock is acquired, false otherwise
     * @throws If parent directory not exists, or is not writeable
     */
@@ -309,7 +309,7 @@ class file
   }
 
   /** Unlock a file previously locked
-    * @param $filename The file to lock
+    * @param string $filename The file to lock
     * @return bool true if the lock is acquired, false otherwise
     * @throws If parent directory not exists, or is not writeable
     */
@@ -328,7 +328,7 @@ class file
   }
 
   /** Calculate the md5 sum of a file
-    * @param $filename The file to hash
+    * @param string $filename The file to hash
     * @return the calulated hash
     * @throws If the file doesn't exists
     */
@@ -349,9 +349,9 @@ class file
   }
 
   /** Create a new directory
-    * @param $pathname The directory to create
-    * @param $mode The mode to create (0777 by default)
-    * @param $recursive (false by default)
+    * @param string $pathname The directory to create
+    * @param integer $mode The mode to create (0777 by default)
+    * @param boolean $recursive (false by default)
     * @return bool true if the directory is correctely created, false if the
     *              directory already exists
     * @throws If parent directory not exists, is not writeable
@@ -576,7 +576,7 @@ class file
   }
 
   /** Calculate the sha1 sum of a file
-    * @param $filename The file to hash
+    * @param string $filename The file to hash
     * @return the calulated hash
     * @throws If the file doesn't exists
     */
@@ -598,7 +598,8 @@ class file
 
   /** Create a new file or update the timestamp if the file exists
     * @param string $filename the filename
-    * @param int $time the timestamp to use (actual timestamp if not defined)
+    * @param integer|null $time the timestamp to use (actual timestamp if not
+    * defined)
     * @return bool true or false on failure
     * @throws If parent directory not exists, is not writeable
     */
@@ -635,7 +636,7 @@ class file
     * executable. The path must exists.
     * Must use the filesystem path (complete) and not the version in chroot.
     * The last directoy must be executable and readable (no test for writeable)
-    * @param $path string The directory path to check
+    * @param string $path The directory path to check
     * @return true if the path is executable for all the parents and for the
     *              last directory
     * @throws if there is a missing part, or a parent is not executable
@@ -716,7 +717,7 @@ class file
     * executable. The path must exists.
     * Must use the filesystem path (complete) and not the version in chroot.
     * The last directoy must be executable and readable and writeable
-    * @param $path string The directory path to check
+    * @param string $path The directory path to check
     * @return true if the path is executable for all the parents and for the
     *              last directory
     * @throws if there is a missing part, or a parent is not executable
@@ -747,9 +748,9 @@ class file
   }
 
   /** Save a debug log
-    * @param $prio The message priority. Should be higher than $this->debug to
-    *              save the message
-    * @param $message The message to save
+    * @param integer $prio The message priority. Should be higher than
+    *        $this->debug to save the message
+    * @param string $message The message to save
     * @return null;
     */
   private function debug ($prio, $message)