Merge "SiteStats::jobs fix when there is a single job"

[lhc/web/wiklou.git] / resources / src / mediawiki / mediawiki.storage.js

diff --git a/resources/src/mediawiki/mediawiki.storage.js b/resources/src/mediawiki/mediawiki.storage.js
index 20f8efb..84e146a 100644 (file)
--- a/resources/src/mediawiki/mediawiki.storage.js
+++ b/resources/src/mediawiki/mediawiki.storage.js
@@ -22,10 +22,6 @@
         *
         * @class mw.SafeStorage
         * @private
-        */
-
-       /**
-        * @ignore
         * @param {Object|undefined} store The Storage instance to wrap around
         */
        function SafeStorage( store ) {
@@ -36,7 +32,8 @@
         * Retrieve value from device storage.
         *
         * @param {string} key Key of item to retrieve
-        * @return {string|boolean} False when localStorage not available, otherwise string
+        * @return {string|null|boolean} String value, null if no value exists, or false
+        *  if localStorage is not available.
         */
        SafeStorage.prototype.get = function ( key ) {
                try {
@@ -46,12 +43,12 @@
        };
 
        /**
-         * Set a value in device storage.
-         *
-         * @param {string} key Key name to store under
-         * @param {string} value Value to be stored
-         * @return {boolean} Whether the save succeeded or not
-         */
+        * Set a value in device storage.
+        *
+        * @param {string} key Key name to store under
+        * @param {string} value Value to be stored
+        * @return {boolean} Whether the save succeeded or not
+        */
        SafeStorage.prototype.set = function ( key, value ) {
                try {
                        this.store.setItem( key, value );
@@ -61,11 +58,11 @@
        };
 
        /**
-         * Remove a value from device storage.
-         *
-         * @param {string} key Key of item to remove
-         * @return {boolean} Whether the save succeeded or not
-         */
+        * Remove a value from device storage.
+        *
+        * @param {string} key Key of item to remove
+        * @return {boolean} Whether the save succeeded or not
+        */
        SafeStorage.prototype.remove = function ( key ) {
                try {
                        this.store.removeItem( key );
@@ -75,6 +72,9 @@
        };
 
        /**
+        * A wrapper for the HTML5 `localStorage` interface
+        * that is safe to call on all browsers.
+        *
         * @class
         * @singleton
         * @extends mw.SafeStorage
@@ -82,6 +82,9 @@
        mw.storage = new SafeStorage( localStorage );
 
        /**
+        * A wrapper for the HTML5 `sessionStorage` interface
+        * that is safe to call on all browsers.
+        *
         * @class
         * @singleton
         * @extends mw.SafeStorage