Added documentation note to class for be avaible by the API viewer.

Also done a little change about special characters, there is no issues with them.
iceteagroup · Aug 30, 2016 · 41cdf39 · 41cdf39
1 parent 67bbce1
commit 41cdf39
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,4 +2,4 @@
 
 ## Breaking changes
 
-* [qx.bom.Cookie] Previous versions of qooxoo use `escape()` and `unescape()` functions. Since those functions are deprecated, then now qooxdoo use `encodeURIComponent()` and `decodeURIComponent()` functions. This may break some cookies. There no must be issues with special characters like `~!@#$%^&*(){}[]=:/,;?+\'"\\` but some unicode characters like `äëíöü` (etc) are encoded different by `escape()` and `encodeURIComponent()`, so you must take care of this change if you use unicode characters.
+* [qx.bom.Cookie] Previous versions of qooxoo use `escape()` and `unescape()` functions. Since those functions are deprecated, then now qooxdoo use `encodeURIComponent()` and `decodeURIComponent()` functions. This may break some cookies. There are no issues with special characters like `~!@#$%^&*(){}[]=:/,;?+\'"\\` but some unicode characters like `äëíöü` (etc) are encoded different by `escape()` and `encodeURIComponent()`, so you must take care of this change if you use unicode characters.
diff --git a/framework/source/class/qx/bom/Cookie.js b/framework/source/class/qx/bom/Cookie.js
@@ -19,6 +19,13 @@
 
 /**
  * A wrapper for Cookie handling.
+ *
+ * Previous versions of qooxoo use `escape()` and `unescape()` functions. Since those functions
+ * are deprecated, then now qooxdoo use `encodeURIComponent()` and `decodeURIComponent()` functions.
+ * This may break some cookies.
+ * There are no issues with special characters like `~!@#$%^&*(){}[]=:/,;?+\'"\\` but some unicode
+ * characters like `äëíöü` (etc) are encoded different by `escape()` and `encodeURIComponent()`,
+ * so you must take care of this change if you use unicode characters.
  */
 qx.Bootstrap.define("qx.bom.Cookie",
 {
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		## Breaking changes

		* [qx.bom.Cookie] Previous versions of qooxoo use `escape()` and `unescape()` functions. Since those functions are deprecated, then now qooxdoo use `encodeURIComponent()` and `decodeURIComponent()` functions. This may break some cookies. There no must be issues with special characters like `~!@#$%^&*(){}[]=:/,;?+\'"\\` but some unicode characters like `äëíöü` (etc) are encoded different by `escape()` and `encodeURIComponent()`, so you must take care of this change if you use unicode characters.
		* [qx.bom.Cookie] Previous versions of qooxoo use `escape()` and `unescape()` functions. Since those functions are deprecated, then now qooxdoo use `encodeURIComponent()` and `decodeURIComponent()` functions. This may break some cookies. There are no issues with special characters like `~!@#$%^&*(){}[]=:/,;?+\'"\\` but some unicode characters like `äëíöü` (etc) are encoded different by `escape()` and `encodeURIComponent()`, so you must take care of this change if you use unicode characters.