From c3c4015df1ff8d9872053d9fa49f66f0d2cc148d Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@users.sourceforge.net>
Date: Wed, 29 Sep 2010 13:14:48 +0000
Subject: [PATCH] Doxygen
---
htdocs/lib/files.lib.php | 41 +++++++++++++++++-------------------
htdocs/lib/functions.lib.php | 24 ++++++++++-----------
2 files changed, 31 insertions(+), 34 deletions(-)
diff --git a/htdocs/lib/files.lib.php b/htdocs/lib/files.lib.php
index b69aeb70460..f1a348e877a 100644
--- a/htdocs/lib/files.lib.php
+++ b/htdocs/lib/files.lib.php
@@ -258,9 +258,9 @@ function dol_mimetype($file,$default='application/octet-stream',$mode=0)
/**
- * \brief Test if filename is a directory
- * \param folder Name of folder
- * \return boolean True if it's a directory, False if not found
+ * Test if filename is a directory
+ * @param folder Name of folder
+ * @return boolean True if it's a directory, False if not found
*/
function dol_is_dir($folder)
{
@@ -269,11 +269,21 @@ function dol_is_dir($folder)
else return false;
}
+/**
+ * Return if path is a file
+ * @param $pathoffile
+ * @return boolean True or false
+ */
+function dol_is_file($pathoffile)
+{
+ $newpathoffile=dol_osencode($pathoffile);
+ return is_file($newpathoffile);
+}
/**
- * \brief Test if a folder is empty
- * \param folder Name of folder
- * \return boolean True if dir is empty or non-existing, False if it contains files
+ * Test if a folder is empty
+ * @param folder Name of folder
+ * @return boolean True if dir is empty or non-existing, False if it contains files
*/
function dol_dir_is_emtpy($folder)
{
@@ -297,9 +307,9 @@ function dol_dir_is_emtpy($folder)
}
/**
- * \brief Count number of lines in a file
- * \param file Filename
- * \return int <0 if KO, Number of lines in files if OK
+ * Count number of lines in a file
+ * @param file Filename
+ * @return int <0 if KO, Number of lines in files if OK
*/
function dol_count_nb_of_line($file)
{
@@ -328,7 +338,6 @@ function dol_count_nb_of_line($file)
/**
* Return size of a file
- *
* @param $pathoffile
* @return string File size
*/
@@ -350,18 +359,6 @@ function dol_filemtime($pathoffile)
return filemtime($newpathoffile);
}
-/**
- * Return if path is a file
- *
- * @param $pathoffile
- * @return boolean True or false
- */
-function dol_is_file($pathoffile)
-{
- $newpathoffile=dol_osencode($pathoffile);
- return is_file($newpathoffile);
-}
-
/**
* Copy a file to another file
* @param $srcfile Source file (can't be a directory)
diff --git a/htdocs/lib/functions.lib.php b/htdocs/lib/functions.lib.php
index 0179bd06a6b..60f9c111483 100644
--- a/htdocs/lib/functions.lib.php
+++ b/htdocs/lib/functions.lib.php
@@ -2250,10 +2250,10 @@ function print_fleche_navigation($page,$file,$options='',$nextpage,$betweenarrow
/**
- * \brief Remove a file or several files with a mask
- * \param file File to delete or mask of file to delete
- * \param disableglob Disable usage of glob like *
- * \param boolean True if file is deleted, False if error
+ * Remove a file or several files with a mask
+ * @param file File to delete or mask of file to delete
+ * @param disableglob Disable usage of glob like *
+ * @param boolean True if file is deleted, False if error
*/
function dol_delete_file($file,$disableglob=0)
{
@@ -2279,10 +2279,10 @@ function dol_delete_file($file,$disableglob=0)
}
/**
- * \brief Remove a directory
- * \param file Directory to delete
- * \return boolean True if success, false if error
- * \remarks If directory is not empty, return false
+ * Remove a directory (not recursive, so content must be empty).
+ * If directory is not empty, return false
+ * @param file Directory to delete
+ * @return boolean True if success, false if error
*/
function dol_delete_dir($dir)
{
@@ -2291,10 +2291,10 @@ function dol_delete_dir($dir)
}
/**
- * \brief Remove a directory $dir and its subdirectories
- * \param file Dir to delete
- * \param count Counter to count nb of deleted elements
- * \return int Number of files and directory removed
+ * Remove a directory $dir and its subdirectories
+ * @param file Dir to delete
+ * @param count Counter to count nb of deleted elements
+ * @return int Number of files and directory removed
*/
function dol_delete_dir_recursive($dir,$count=0)
{
--
GitLab