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, 12 insertions, 6 deletions

diff --git a/include/functions_metadata.inc.php b/include/functions_metadata.inc.php
index 0727feb1e..255f8221d 100644
--- a/include/functions_metadata.inc.php
+++ b/include/functions_metadata.inc.php
@@ -22,10 +22,15 @@
 // +-----------------------------------------------------------------------+
 
 /**
- * returns informations from IPTC metadata, mapping is done at the beginning
- * of the function
+ * @package functions\metadata
+ */
+
+
+/**
+ * returns informations from IPTC metadata, mapping is done in this function.
  *
  * @param string $filename
+ * @param array $map
  * @return array
  */
 function get_iptc_data($filename, $map)
@@ -80,9 +85,9 @@ function get_iptc_data($filename, $map)
 }
 
 /**
- * return a cleaned IPTC value
+ * return a cleaned IPTC value.
  *
- * @param string value
+ * @param string $value
  * @return string
  */
 function clean_iptc_value($value)
@@ -127,10 +132,10 @@ function clean_iptc_value($value)
 }
 
 /**
- * returns informations from EXIF metadata, mapping is done at the beginning
- * of the function
+ * returns informations from EXIF metadata, mapping is done in this function.
  *
  * @param string $filename
+ * @param array $map
  * @return array
  */
 function get_exif_data($filename, $map)
@@ -180,4 +185,5 @@ function get_exif_data($filename, $map)
 
   return $result;
 }
+
 ?>
\ No newline at end of file