Adding documentation for CookieComponent

git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@5867 3807eeeb-6ff5-0310-8944-8be069107fe0

cake/libs/controller/components/cookie.php

@@ -197,7 +197,7 @@ class CookieComponent extends Object {
 		}
 	}
 /**
- * Write a value to the $_COOKIE[$config];
+ * Write a value to the $_COOKIE[$key];
  *
  * Optional [Name.], reguired key, optional $value, optional $encrypt, optional $expires
  * $this->Cookie->write('[Name.]key, $value);
@@ -208,10 +208,10 @@ class CookieComponent extends Object {
  * You must use this method before any output is sent to the browser.
  * Failure to do so will result in header already sent errors.
  *
- * @param mixed $key
- * @param mixed $value
- * @param boolean $encrypt
- * @param string $expires
+ * @param mixed $key Key for the value
+ * @param mixed $value Value
+ * @param boolean $encrypt Set to true to encrypt value, false otherwise
+ * @param string $expires Can be either Unix timestamp, or date string
  * @access public
  */
 	function write($key, $value = null, $encrypt = true, $expires = null) {
@@ -247,13 +247,13 @@ class CookieComponent extends Object {
 		}
 	}
 /**
- * Read the value of the $_COOKIE[$var];
+ * Read the value of the $_COOKIE[$key];
  *
  * Optional [Name.], reguired key
  * $this->Cookie->read(Name.key);
  *
- * @param mixed $key
- * @return string or null
+ * @param mixed $key Key of the value to be obtained. If none specified, obtain map key => values
+ * @return string or null, value for specified key
  * @access public
  */
 	function read($key = null) {
@@ -290,7 +290,7 @@ class CookieComponent extends Object {
  * You must use this method before any output is sent to the browser.
  * Failure to do so will result in header already sent errors.
  *
- * @param string $name
+ * @param string $key Key of the value to be deleted
  * @access public
  */
 	function del($key) {
@@ -340,7 +340,7 @@ class CookieComponent extends Object {
 /**
  * Will allow overriding default encryption method.
  *
- * @param string $type
+ * @param string $type Encryption method
  * @access public
  * @todo NOT IMPLEMENTED
  */
@@ -357,8 +357,8 @@ class CookieComponent extends Object {
  * CookieComponent::write(string, string, boolean, 8400);
  * CookieComponent::write(string, string, boolean, '5 Days');
  *
- * @param mixed $expires
- * @return int
+ * @param mixed $expires Can be either Unix timestamp, or date string
+ * @return int Unix timestamp
  * @access private
  */
 	function __expire($expires = null) {
@@ -376,8 +376,8 @@ class CookieComponent extends Object {
 /**
  * Set cookie
  *
- * @param string $name
- * @param string $value
+ * @param string $name Name for cookie
+ * @param string $value Value for cookie
  * @access private
  */
 	function __write($name, $value) {
@@ -392,7 +392,7 @@ class CookieComponent extends Object {
 /**
  * Sets a cookie expire time to remove cookie value
  *
- * @param string $name
+ * @param string $name Name of cookie
  * @access private
  */
 	function __delete($name) {
@@ -401,8 +401,8 @@ class CookieComponent extends Object {
 /**
   * Encrypts $value using var $type method in Security class
   *
-  * @param string $value
-  * @return encrypted string
+  * @param string $value Value to encrypt
+  * @return string encrypted string
   * @access private
   */
 	 function __encrypt($value) {
@@ -419,8 +419,8 @@ class CookieComponent extends Object {
 /**
  * Decrypts $value using var $type method in Security class
  *
- * @param string $values
- * @return decrypted string
+ * @param array $values Values to decrypt
+ * @return string decrypted string
  * @access private
  */
 	function __decrypt($values) {
@@ -456,8 +456,8 @@ class CookieComponent extends Object {
  * Creates an array from the $name parameter which allows the dot notation
  * similar to one used by Session and Configure classes
  *
- * @param string $name
- * @return array
+ * @param string $name Name with or without dot notation
+ * @return array Extracted names
  * @access private
  */
 	function __cookieVarNames($name) {
@@ -473,8 +473,8 @@ class CookieComponent extends Object {
 /**
  * Implode method to keep keys are multidimensional arrays
  *
- * @param array $array
- * @return string
+ * @param array $array Map of key and values
+ * @return string String in the form key1|value1,key2|value2
  * @access private
  */
 	function __implode($array) {
@@ -487,8 +487,8 @@ class CookieComponent extends Object {
 /**
  * Explode method to return array from string set in CookieComponent::__implode()
  *
- * @param string $string
- * @return array
+ * @param string $string String in the form key1|value1,key2|value2
+ * @return array Map of key and values
  * @access private
  */
 	function __explode($string) {