summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDerek Jones <derek.jones@ellislab.com>2013-07-20 18:00:02 +0200
committerDerek Jones <derek.jones@ellislab.com>2013-07-20 18:00:02 +0200
commit26f7a9fb4aa08c66c2842b90b4f5ab1a08076df6 (patch)
tree86f3d8dc26f832cf1429e565f3215d8a380162d7
parenta4db4320c529a3421d6193c1d2e84e81f8bc2898 (diff)
fixed param options on cookie helper function definitions
-rw-r--r--user_guide_src/source/helpers/cookie_helper.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst
index 41a6d1c56..e70893f2f 100644
--- a/user_guide_src/source/helpers/cookie_helper.rst
+++ b/user_guide_src/source/helpers/cookie_helper.rst
@@ -25,7 +25,7 @@ Available Functions
The following functions are available:
-.. function:: set_cookie($name = ''[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]])
+.. function:: set_cookie([$name = ''[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]]])
:param mixed $name: Cookie name *or* associative array of all of
the parameters available to this function
@@ -44,7 +44,7 @@ The following functions are available:
``CI_Input::set_cookie()``.
-.. function:: get_cookie($index = '', $xss_clean = FALSE)
+.. function:: get_cookie([$index = ''[, $xss_clean = FALSE]])
:param string $index: Cookie name
:param bool $xss_clean: Whether to apply XSS filtering to the returned value
@@ -55,7 +55,7 @@ The following functions are available:
description of its use, as this function is an alias for ``CI_Input::cookie()``.
-.. function:: delete_cookie($name = '', $domain = '', $path = '/', $prefix = '')
+.. function:: delete_cookie([$name = ''[, $domain = ''[, $path = '/'[, $prefix = '']]]])
:param string $name: Cookie name
:param string $domain: Cookie domain (usually: .yourdomain.com)