Author: zhen
Date: Mon Jan 28 14:03:30 2008
New Revision: 616078
URL: http://svn.apache.org/viewvc?rev=616078&view=rev
Log:
Minor documentation fixes in gadget.Prefs.
Modified:
incubator/shindig/trunk/features/core/prefs.js
Modified: incubator/shindig/trunk/features/core/prefs.js
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/features/core/prefs.js?rev=616078&r1=616077&r2=616078&view=diff
==============================================================================
--- incubator/shindig/trunk/features/core/prefs.js (original)
+++ incubator/shindig/trunk/features/core/prefs.js Mon Jan 28 14:03:30 2008
@@ -155,7 +155,7 @@
}();
/**
- * @class
+ * @class
* Provides access to user preferences, module dimensions, and messages.
*
* Clients can access their preferences by constructing an instance of
@@ -234,7 +234,7 @@
}
/**
- * Retrieves a string preference.
+ * Retrieves a preference as a string.
* @param {String} key The preference to fetch
* @return {String} The preference; if not set, an empty string
*/
@@ -244,7 +244,7 @@
};
/**
- * Retrieves an integer preference.
+ * Retrieves a preference as an integer.
* @param {String} key The preference to fetch
* @return {Number} The preference; if not set, 0
*/
@@ -254,7 +254,7 @@
};
/**
- * Retrieves a floating-point preference.
+ * Retrieves a preference as a floating-point value.
* @param {String} key The preference to fetch
* @return {Number} The preference; if not set, 0
*/
@@ -264,7 +264,7 @@
};
/**
- * Retrieves a boolean preference.
+ * Retrieves a preference as a boolean.
* @param {String} key The preference to fetch
* @return {Boolean} The preference; if not set, false
*/
@@ -295,7 +295,7 @@
};
/**
- * Retrieves an array preference.
+ * Retrieves a preference as an array.
* UserPref values that were not declared as lists are treated as
* one-element arrays.
*
