Merge pull request #42 from BenoitDuffez/fix_return_bool_phpdoc

fix @return true... to @return bool true... on some functions
pear · Oct 9, 2022 · 486a389 · 486a389
2 parents 737f594 + bc21637
commit 486a389
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/Archive/Tar.php b/Archive/Tar.php
@@ -280,7 +280,7 @@ public function __destruct()
      *              single string with names separated by a single
      *              blank space.
      *
-     * @return true on success, false on error.
+     * @return bool true on success, false on error.
      * @see    createModify()
      */
     public function create($p_filelist)
@@ -300,7 +300,7 @@ public function create($p_filelist)
      *              single string with names separated by a single
      *              blank space.
      *
-     * @return true on success, false on error.
+     * @return bool true on success, false on error.
      * @see    createModify()
      * @access public
      */
@@ -443,7 +443,7 @@ public function createModify($p_filelist, $p_add_dir, $p_remove_dir = '')
      *                             each element in the list, when
      *                             relevant.
      *
-     * @return true on success, false on error.
+     * @return bool true on success, false on error.
      */
     public function addModify($p_filelist, $p_add_dir, $p_remove_dir = '')
     {
@@ -496,7 +496,7 @@ public function addModify($p_filelist, $p_add_dir, $p_remove_dir = '')
      *                               gid => the group ID of the file
      *                                   (default = 0 = root)
      *
-     * @return true on success, false on error.
+     * @return bool true on success, false on error.
      */
     public function addString($p_filename, $p_string, $p_datetime = false, $p_params = array())
     {
@@ -622,7 +622,7 @@ public function extractInString($p_filename)
      * @param boolean $p_preserve Preserve user/group ownership of files
      * @param boolean $p_symlinks Allow symlinks.
      *
-     * @return true on success, false on error.
+     * @return bool true on success, false on error.
      * @see    extractModify()
      */
     public function extractList($p_filelist, $p_path = '', $p_remove_path = '', $p_preserve = false, $p_symlinks = true)
@@ -660,7 +660,7 @@ public function extractList($p_filelist, $p_path = '', $p_remove_path = '', $p_p
      * list of parameters, in the format attribute code + attribute values :
      * $arch->setAttribute(ARCHIVE_TAR_ATT_SEPARATOR, ',');
      *
-     * @return true on success, false on error.
+     * @return bool true on success, false on error.
      */
     public function setAttribute()
     {