Changeset 25548 for trunk/include/functions_cookie.inc.php

Timestamp:

Nov 18, 2013, 11:02:17 AM (10 years ago)

Author:

mistic100

Message:

feature 2999: documentation of functions\comment|cookie|filter|html

File:

• trunk/include/functions_cookie.inc.php (modified) (3 diffs)

trunk/include/functions_cookie.inc.php

@@ -22 +22 @@
 // +-----------------------------------------------------------------------+
 
-// cookie_path returns the path to use for the Piwigo cookie.
-// If Piwigo is installed on :
-// http://domain.org/meeting/gallery/category.php
-// cookie_path will return : "/meeting/gallery"
+/**
+ * @package functions\cookie
+ */
+
+
+/**
+ * Returns the path to use for the Piwigo cookie.
+ * If Piwigo is installed on :
+ * http://domain.org/meeting/gallery/
+ * it will return : "/meeting/gallery"
+ *
+ * @return string
+ */
 function cookie_path()
 {
@@ -84 +93 @@
 
 /**
- * persistently stores a variable in pwg cookie
- * @return boolean true on success
- * @see pwg_get_cookie_var
+ * Persistently stores a variable in pwg cookie.
+ * Set $value to null to delete the cookie.
+ *
+ * @param string $car
+ * @param mixed $value
+ * @param int|null $expire
+ * @return bool
  */
 function pwg_set_cookie_var($var, $value, $expire=null)
@@ -105 +118 @@
 
 /**
- * retrieves the value of a persistent variable in pwg cookie
+ * Retrieves the value of a persistent variable in pwg cookie
+ * @see pwg_set_cookie_var
+ *
+ * @param string $var
+ * @param mixed $default
  * @return mixed
- * @see pwg_set_cookie_var
  */
 function pwg_get_cookie_var($var, $default = null)