aboutsummaryrefslogtreecommitdiffstats
path: root/include/functions_picture.inc.php
diff options
context:
space:
mode:
authormistic100 <mistic@piwigo.org>2013-11-18 17:36:35 +0000
committermistic100 <mistic@piwigo.org>2013-11-18 17:36:35 +0000
commitb8eeae36dc577e0d0723b1ed27789f606041dbdd (patch)
tree61d6c9e91b2feb7cdfe1273190a256433b9387b9 /include/functions_picture.inc.php
parent0ed662ef77a81ddd1efdb972620965dd70fad72c (diff)
feature 2999: Documentation of include/functions_mail|metadata|picture
git-svn-id: http://piwigo.org/svn/trunk@25550 68402e56-0260-453c-a942-63ccdbb3a9ee
Diffstat (limited to '')
-rw-r--r--include/functions_picture.inc.php49
1 files changed, 26 insertions, 23 deletions
diff --git a/include/functions_picture.inc.php b/include/functions_picture.inc.php
index b8247fd23..0333fe088 100644
--- a/include/functions_picture.inc.php
+++ b/include/functions_picture.inc.php
@@ -21,13 +21,18 @@
// | USA. |
// +-----------------------------------------------------------------------+
+/**
+ * @package functions\picture
+ */
-/*
- * get slideshow default params into array
- *
- * @param void
+
+/**
+ * Returns slideshow default params.
+ * - period
+ * - repeat
+ * - play
*
- * @return slideshow default values into array
+ * @return array
*/
function get_default_slideshow_params()
{
@@ -40,14 +45,13 @@ function get_default_slideshow_params()
);
}
-/*
- * check and correct slideshow params from array
- *
- * @param array of params
+/**
+ * Checks and corrects slideshow params
*
- * @return slideshow corrected values into array
+ * @param array $params
+ * @return array
*/
-function correct_slideshow_params($params = array())
+function correct_slideshow_params($params=array())
{
global $conf;
@@ -63,14 +67,13 @@ function correct_slideshow_params($params = array())
return $params;
}
-/*
- * Decode slideshow string params into array
+/**
+ * Decodes slideshow string params into array
*
- * @param string params like ""
- *
- * @return slideshow values into array
+ * @param string $encode_params
+ * @return array
*/
-function decode_slideshow_params($encode_params = null)
+function decode_slideshow_params($encode_params=null)
{
global $conf;
@@ -105,14 +108,13 @@ function decode_slideshow_params($encode_params = null)
return correct_slideshow_params($result);
}
-/*
- * Encode slideshow array params into array
- *
- * @param array params
+/**
+ * Encodes slideshow array params into a string
*
- * @return slideshow values into string
+ * @param array $decode_params
+ * @return string
*/
-function encode_slideshow_params($decode_params = array())
+function encode_slideshow_params($decode_params=array())
{
global $conf;
@@ -127,4 +129,5 @@ function encode_slideshow_params($decode_params = array())
return $result;
}
+
?> \ No newline at end of file