Upgrade to ExtJS 3.0.3 - Released 10/11/2009
[extjs.git] / docs / source / Cookies.html
index 4df5f2b..330c7c6 100644 (file)
@@ -1,11 +1,17 @@
-<html>\r
-<head>\r
-  <title>The source code</title>\r
-    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
-    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
-</head>\r
-<body  onload="prettyPrint();">\r
-    <pre class="prettyprint lang-js"><div id="cls-Ext.util.Cookies"></div>/**\r
+<html>
+<head>
+  <title>The source code</title>
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+</head>
+<body  onload="prettyPrint();">
+    <pre class="prettyprint lang-js">/*!
+ * Ext JS Library 3.0.3
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+<div id="cls-Ext.util.Cookies"></div>/**\r
  * @class Ext.util.Cookies\r
  * Utility class for managing and interacting with cookies.\r
  * @singleton\r
@@ -15,8 +21,8 @@ Ext.util.Cookies = {
      * Create a cookie with the specified name and value. Additional settings\r
      * for the cookie may be optionally specified (for example: expiration,\r
      * access restriction, SSL).\r
-     * @param {Object} name\r
-     * @param {Object} value\r
+     * @param {String} name The name of the cookie to set. \r
+     * @param {Mixed} value The value to set for the cookie.\r
      * @param {Object} expires (Optional) Specify an expiration date the\r
      * cookie is to persist until.  Note that the specified Date object will\r
      * be converted to Greenwich Mean Time (GMT). \r
@@ -51,7 +57,7 @@ Ext.util.Cookies = {
      * <pre><code>\r
      * var validStatus = Ext.util.Cookies.get("valid");\r
      * </code></pre>\r
-     * @param {Object} name The name of the cookie to get\r
+     * @param {String} name The name of the cookie to get\r
      * @return {Mixed} Returns the cookie value for the specified name;\r
      * null if the cookie name does not exist.\r
      */\r
@@ -76,8 +82,8 @@ Ext.util.Cookies = {
 \r
     <div id="method-Ext.util.Cookies-clear"></div>/**\r
      * Removes a cookie with the provided name from the browser\r
-     * if found.\r
-     * @param {Object} name The name of the cookie to remove\r
+     * if found by setting its expiration date to sometime in the past. \r
+     * @param {String} name The name of the cookie to remove\r
      */\r
     clear : function(name){\r
         if(Ext.util.Cookies.get(name)){\r
@@ -94,6 +100,6 @@ Ext.util.Cookies = {
         }\r
         return unescape(document.cookie.substring(offset, endstr));\r
     }\r
-};</pre>    \r
-</body>\r
+};</pre>
+</body>
 </html>
\ No newline at end of file