feature 2999: Documentation of include/functions_mail|metadata|picture

git-svn-id: http://piwigo.org/svn/trunk@25550 68402e56-0260-453c-a942-63ccdbb3a9ee

1 files changed, 8 insertions, 1 deletions

diff --git a/include/functions.inc.php b/include/functions.inc.php
index 40f8810e5..03c9e2873 100644
--- a/include/functions.inc.php
+++ b/include/functions.inc.php
@@ -103,12 +103,19 @@ function get_filename_wo_extension( $filename )
   return ($pos===false) ? $filename : substr( $filename, 0, $pos);
 }
 
+/** no option for mkgetdir() */
 define('MKGETDIR_NONE', 0);
+/** sets mkgetdir() recursive */
 define('MKGETDIR_RECURSIVE', 1);
+/** sets mkgetdir() exit script on error */
 define('MKGETDIR_DIE_ON_ERROR', 2);
+/** sets mkgetdir() add a index.htm file */
 define('MKGETDIR_PROTECT_INDEX', 4);
+/** sets mkgetdir() add a .htaccess file*/
 define('MKGETDIR_PROTECT_HTACCESS', 8);
-define('MKGETDIR_DEFAULT', 7);
+/** default options for mkgetdir() = MKGETDIR_RECURSIVE | MKGETDIR_DIE_ON_ERROR | MKGETDIR_PROTECT_INDEX */
+define('MKGETDIR_DEFAULT', MKGETDIR_RECURSIVE | MKGETDIR_DIE_ON_ERROR | MKGETDIR_PROTECT_INDEX);
+
 /**
  * creates directory if not exists and ensures that directory is writable
  *