You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shindig.apache.org by li...@apache.org on 2010/01/13 21:57:34 UTC
svn commit: r898941 [2/2] - in
/incubator/shindig/trunk/features/src/main/javascript/features: core.auth/
core.config/ core.io/ core.json/ core.legacy/ core.log/ core.prefs/
core.util/ dynamic-height.util/ dynamic-height/ flash/ i18n/ minimessage/
oaut...
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/dataresponse.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/dataresponse.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/dataresponse.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/dataresponse.js Wed Jan 13 20:57:30 2010
@@ -45,10 +45,11 @@
* Construct the data response.
* This object contains the requested server data mapped to the requested keys.
*
- * @param {Map.<String, ResponseItem>} responseItems Key/value map of data
+ * @param {Object.<string, ResponseItem>} responseItems Key/value map of data
* response information
- * @param {Boolean} opt_globalError Optional field indicating whether there were
+ * @param {boolean=} opt_globalError Optional field indicating whether there were
* any errors generating this data response
+ * @param {string=} opt_errorMessage
*
* @private
* @constructor
@@ -64,7 +65,7 @@
/**
* Returns true if there was an error in fetching this data from the server.
*
- * @return {Boolean} True if there was an error; otherwise, false
+ * @return {boolean} True if there was an error; otherwise, false
* @member opensocial.DataResponse
*/
opensocial.DataResponse.prototype.hadError = function() {
@@ -75,7 +76,7 @@
/**
* If the entire request had a batch level error, returns the error message.
*
- * @return {String} A human-readable description of the error that occurred.
+ * @return {string} A human-readable description of the error that occurred.
*/
opensocial.DataResponse.prototype.getErrorMessage = function() {
return this.errorMessage_;
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/email.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/email.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/email.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/email.js Wed Jan 13 20:57:30 2010
@@ -72,14 +72,14 @@
/**
* Gets data for this body type that is associated with the specified key.
*
- * @param {String} key The key to get data for;
+ * @param {string} key The key to get data for;
* keys are defined in <a href="opensocial.Email.Field.html"><code>
* Email.Field</code></a>
- * @param {Map.<opensocial.DataRequest.DataRequestFields, Object>}
+ * @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {String} The data
+ * @return {string} The data
*/
opensocial.Email.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/enum.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/enum.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/enum.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/enum.js Wed Jan 13 20:57:30 2010
@@ -78,7 +78,7 @@
* Use this for logic within your gadget. If they key is null then the value
* does not fit in the defined enums.
*
- * @return {String} The enum's key. This should be one of the defined enums
+ * @return {string} The enum's key. This should be one of the defined enums
* below.
*/
opensocial.Enum.prototype.getKey = function() {
@@ -90,7 +90,7 @@
* The value of this enum. This will be a user displayable string. If the
* container supports localization, the string will be localized.
*
- * @return {String} The enum's value.
+ * @return {string} The enum's value.
*/
opensocial.Enum.prototype.getDisplayValue = function() {
return gadgets.util.escape(this.displayValue);
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/environment.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/environment.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/environment.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/environment.js Wed Jan 13 20:57:30 2010
@@ -39,8 +39,8 @@
/**
* Base interface for all environment objects.
*
- * @param {String} domain The current domain
- * @param {Map.<String, Map.<String, Boolean>>} supportedFields
+ * @param {string} domain The current domain
+ * @param {Object.<string, Object.<string, boolean>>} supportedFields
* The fields supported by this container
*
* @private
@@ -56,7 +56,7 @@
* Returns the current domain —
* for example, "orkut.com" or "myspace.com".
*
- * @return {String} The domain
+ * @return {string} The domain
*/
opensocial.Environment.prototype.getDomain = function() {
return this.domain;
@@ -143,8 +143,8 @@
* @param {opensocial.Environment.ObjectType} objectType
* The <a href="opensocial.Environment.ObjectType.html">object type</a>
* to check for the field
- * @param {String} fieldName The name of the field to check for
- * @return {Boolean} True if the field is supported on the specified object type
+ * @param {string} fieldName The name of the field to check for
+ * @return {boolean} True if the field is supported on the specified object type
*/
opensocial.Environment.prototype.supportsField = function(objectType,
fieldName) {
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/idspec.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/idspec.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/idspec.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/idspec.js Wed Jan 13 20:57:30 2010
@@ -142,14 +142,14 @@
/**
* Gets the id spec's data that's associated with the specified key.
*
- * @param {String} key The key to get data for;
+ * @param {string} key The key to get data for;
* see the <a href="opensocial.IdSpec.Field.html">Field</a> class
* for possible values
- * @param {Map.<opensocial.DataRequest.DataRequestFields, Object>}
+ * @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {String} The data
+ * @return {string} The data
* @member opensocial.IdSpec
*/
opensocial.IdSpec.prototype.getField = function(key, opt_params) {
@@ -160,8 +160,8 @@
/**
* Sets data for this id spec associated with the given key.
*
- * @param {String} key The key to set data for
- * @param {String} data The data to set
+ * @param {string} key The key to set data for
+ * @param {string} data The data to set
*/
opensocial.IdSpec.prototype.setField = function(key, data) {
return (this.fields_[key] = data);
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/mediaitem.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/mediaitem.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/mediaitem.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/mediaitem.js Wed Jan 13 20:57:30 2010
@@ -32,9 +32,9 @@
/**
* Represents images, movies, and audio.
*
- * @param {String} mimeType The media's type
- * @param {String} url The media's location
- * @param {Map.<opensocial.MediaItem.Field, Object>} opt_params
+ * @param {string} mimeType The media's type
+ * @param {string} url The media's location
+ * @param {Object.<opensocial.MediaItem.Field, Object>=} opt_params
* Any other fields that should be set on the media item object.
* All of the defined Fields are supported.
* @constructor
@@ -116,10 +116,10 @@
/**
* Gets the media item data that's associated with the specified key.
*
- * @param {String} key The key to get data for; see the
+ * @param {string} key The key to get data for; see the
* <a href="opensocial.MediaItem.Field.html">Field</a> class
* for possible values
- * @return {String} The data
+ * @return {string} The data
*/
opensocial.MediaItem.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
@@ -129,8 +129,8 @@
/**
* Sets data for this media item associated with the given key.
*
- * @param {String} key The key to set data for
- * @param {String} data The data to set
+ * @param {string} key The key to set data for
+ * @param {string} data The data to set
*/
opensocial.MediaItem.prototype.setField = function(key, data) {
return (this.fields_[key] = data);
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/message.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/message.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/message.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/message.js Wed Jan 13 20:57:30 2010
@@ -41,8 +41,8 @@
/**
* Base interface for all message objects.
*
- * @param {String} body The main text of the message.
- * @param {Map.<opensocial.Message.Field, Object>} opt_params Any other
+ * @param {string} body_or_params The main text of the message.
+ * @param {Object.<opensocial.Message.Field, Object>=} opt_params Any other
* fields that should be set on the message object. All of the defined
* Fields are supported.
* @private
@@ -235,14 +235,14 @@
/**
* Gets the message data that's associated with the specified key.
*
- * @param {String} key The key to get data for;
+ * @param {string} key The key to get data for;
* see the <a href="opensocial.Message.Field.html">Field</a> class
* for possible values
- * @param {Map.<opensocial.DataRequest.DataRequestFields, Object>}
+ * @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {String} The data
+ * @return {string} The data
* @member opensocial.Message
*/
opensocial.Message.prototype.getField = function(key, opt_params) {
@@ -253,8 +253,8 @@
/**
* Sets data for this message associated with the given key.
*
- * @param {String} key The key to set data for
- * @param {String} data The data to set
+ * @param {string} key The key to set data for
+ * @param {string} data The data to set
*/
opensocial.Message.prototype.setField = function(key, data) {
return (this.fields_[key] = data);
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/messagecollection.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/messagecollection.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/messagecollection.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/messagecollection.js Wed Jan 13 20:57:30 2010
@@ -35,8 +35,7 @@
/**
* Base interface for all message collection objects.
*
- * @param {String} body The main text of the message.
- * @param {Map.<opensocial.MessageCollection.Field, Object>} opt_params Any other
+ * @param {Object.<opensocial.MessageCollection.Field, Object>=} opt_params Any other
* fields that should be set on the message object. All of the defined
* Fields are supported.
* @private
@@ -102,14 +101,14 @@
/**
* Gets the message data that's associated with the specified key.
*
- * @param {String} key The key to get data for;
+ * @param {string} key The key to get data for;
* see the <a href="opensocial.MessageCollection.Field.html">Field</a> class
* for possible values
- * @param {Map.<opensocial.DataRequest.DataRequestFields, Object>}
+ * @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {String} The data
+ * @return {string} The data
* @member opensocial.MessageCollection
*/
opensocial.MessageCollection.prototype.getField = function(key, opt_params) {
@@ -120,8 +119,8 @@
/**
* Sets data for this message associated with the given key.
*
- * @param {String} key The key to set data for
- * @param {String} data The data to set
+ * @param {string} key The key to set data for
+ * @param {string} data The data to set
*/
opensocial.MessageCollection.prototype.setField = function(key, data) {
return this.fields_[key] = data;
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/name.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/name.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/name.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/name.js Wed Jan 13 20:57:30 2010
@@ -99,14 +99,14 @@
/**
* Gets data for this name that is associated with the specified key.
*
- * @param {String} key The key to get data for;
+ * @param {string} key The key to get data for;
* keys are defined in <a href="opensocial.Name.Field.html"><code>
* Name.Field</code></a>
- * @param {Map.<opensocial.DataRequest.DataRequestFields, Object>}
+ * @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {String} The data
+ * @return {string} The data
*/
opensocial.Name.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/navigationparameters.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/navigationparameters.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/navigationparameters.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/navigationparameters.js Wed Jan 13 20:57:30 2010
@@ -103,14 +103,14 @@
/**
* Gets the NavigationParameters' data that's associated with the specified key.
*
- * @param {String} key The key to get data for;
+ * @param {string} key The key to get data for;
* see the <a href="opensocial.NavigationParameters.Field.html">Field</a>
* class for possible values
- * @param {Map.<opensocial.DataRequest.DataRequestFields, Object>}
+ * @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {String} The data
+ * @return {string} The data
* @member opensocial.NavigationParameters
*/
opensocial.NavigationParameters.prototype.getField = function(key, opt_params) {
@@ -121,7 +121,7 @@
/**
* Sets data for this NavigationParameters associated with the given key.
*
- * @param {String} key The key to set data for
+ * @param {string} key The key to set data for
* @param {Object} data The data to set
*/
opensocial.NavigationParameters.prototype.setField = function(key, data) {
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/opensocial.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/opensocial.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/opensocial.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/opensocial.js Wed Jan 13 20:57:30 2010
@@ -58,15 +58,15 @@
* NOT_IMPLEMENTED.
* </p>
*
- * @param {Array.<String> | String} recipients An ID, array of IDs, or a
+ * @param {Array.<string> | string} recipients An ID, array of IDs, or a
* group reference; the supported keys are VIEWER, OWNER, VIEWER_FRIENDS,
* OWNER_FRIENDS, or a single ID within one of those groups
* @param {opensocial.Message} message The message to send to the specified
* users
- * @param {Function} opt_callback The function to call once the request has been
+ * @param {function(opensocial.ResponseItem)=} opt_callback The function to call once the request has been
* processed; either this callback will be called or the gadget will be
* reloaded from scratch
- * @param {opensocial.NavigationParameters} opt_params The optional parameters
+ * @param {opensocial.NavigationParameters=} opt_params The optional parameters
* indicating where to send a user when a request is made, or when a request is
* accepted; options are of type
* <a href="opensocial.NavigationParameters.DestinationType.html">
@@ -100,16 +100,16 @@
* NOT_IMPLEMENTED.
* </p>
*
- * @param {Array.<String> | String} recipients An ID, array of IDs, or a
+ * @param {Array.<string> | string} recipients An ID, array of IDs, or a
* group reference; the supported keys are VIEWER, OWNER, VIEWER_FRIENDS,
* OWNER_FRIENDS, or a single ID within one of those groups
* @param {opensocial.Message} reason The reason the user wants the gadget to
* share itself. This reason can be used by the container when prompting the
* user for permission to share the app. It may also be ignored.
- * @param {Function} opt_callback The function to call once the request has been
+ * @param {function(opensocial.ResponseItem)=} opt_callback The function to call once the request has been
* processed; either this callback will be called or the gadget will be
* reloaded from scratch
- * @param {opensocial.NavigationParameters} opt_params The optional parameters
+ * @param {opensocial.NavigationParameters=} opt_params The optional parameters
* indicating where to send a user when a request is made, or when a request is
* accepted; options are of type
* <a href="opensocial.NavigationParameters.DestinationType.html">
@@ -160,7 +160,7 @@
* @param {opensocial.CreateActivityPriority} priority The
* <a href="opensocial.CreateActivityPriority.html">priority</a> for this
* request
- * @param {Function} opt_callback The function to call once the request has been
+ * @param {function(opensocial.ResponseItem)=} opt_callback The function to call once the request has been
* processed.
*
* @member opensocial
@@ -222,7 +222,7 @@
*
* @param {opensocial.Permission} permission
* The <a href="opensocial.Permission.html">permission</a>
- * @return {Boolean}
+ * @return {boolean}
* True if the gadget has access for the permission; false if it doesn't
*
* @member opensocial
@@ -238,12 +238,12 @@
* opensocial.ResponseItem. The response item will have its error code set to
* NOT_IMPLEMENTED.
*
- * @param {Array.<opensocial.Permission>} permissions
+ * @param {Array.<opensocial.Permission>} permissions
* The <a href="opensocial.Permission.html">permissions</a> to request
* from the viewer
- * @param {String} reason Displayed to the user as the reason why these
+ * @param {string} reason Displayed to the user as the reason why these
* permissions are needed
- * @param {Function} opt_callback The function to call once the request has been
+ * @param {function(opensocial.ResponseItem)=} opt_callback The function to call once the request has been
* processed; either this callback will be called or the gadget will be
* reloaded from scratch. This function will be passed one parameter, an
* opensocial.ResponseItem. The error code will be set to reflect whether
@@ -336,7 +336,7 @@
* <p>See <a href="opensocial.Activity.Field.html">Field</a>s are supported for
* more details.</p>
*
- * @param {Map.<opensocial.Activity.Field, Object>} params
+ * @param {Object.<opensocial.Activity.Field, Object>} params
* Parameters defining the activity.
* @return {opensocial.Activity} The new
* <a href="opensocial.Activity.html">activity</a> object
@@ -352,11 +352,11 @@
* Represents images, movies, and audio.
* Used when creating activities on the server.
*
- * @param {String} mimeType
+ * @param {string} mimeType
* <a href="opensocial.MediaItem.Type.html">MIME type</a> of the
* media
- * @param {String} url Where the media can be found
- * @param {Map.<opensocial.MediaItem.Field, Object>} opt_params
+ * @param {string} url Where the media can be found
+ * @param {Object.<opensocial.MediaItem.Field, Object>=} opt_params
* Any other fields that should be set on the media item object;
* all of the defined
* <a href="opensocial.MediaItem.Field.html">Field</a>s
@@ -376,8 +376,8 @@
* Represents images, movies, and audio.
* Used when creating activities on the server.
*
- * @param {String} body The main text of the message.
- * @param {Map.<opensocial.Message.Field, Object>} opt_params
+ * @param {string} body The main text of the message.
+ * @param {Object.<opensocial.Message.Field, Object>=} opt_params
* Any other fields that should be set on the message object;
* all of the defined
* <a href="opensocial.Message.Field.html">Field</a>s
@@ -417,7 +417,7 @@
/**
* Creates an IdSpec object.
*
- * @param {Map.<opensocial.IdSpec.Field, Object>} parameters
+ * @param {Object.<opensocial.IdSpec.Field, Object>} params
* Parameters defining the id spec.
* @return {opensocial.IdSpec} The new
* <a href="opensocial.IdSpec.html">IdSpec</a> object
@@ -436,7 +436,7 @@
* </p>
*
*
- * @param {Map.<opensocial.NavigationParameters.Field, Object>} parameters
+ * @param {Object.<opensocial.NavigationParameters.Field, Object>} params
* Parameters defining the navigation
* @return {opensocial.NavigationParameters} The new
* <a href="opensocial.NavigationParameters.html">NavigationParameters</a>
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/organization.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/organization.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/organization.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/organization.js Wed Jan 13 20:57:30 2010
@@ -136,14 +136,14 @@
/**
* Gets data for this body type that is associated with the specified key.
*
- * @param {String} key The key to get data for;
+ * @param {string} key The key to get data for;
* keys are defined in <a href="opensocial.Organization.Field.html"><code>
* Organization.Field</code></a>
- * @param {Map.<opensocial.DataRequest.DataRequestFields, Object>}
+ * @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request
- * @return {String} The data
+ * @return {string} The data
*/
opensocial.Organization.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/person.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/person.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/person.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/person.js Wed Jan 13 20:57:30 2010
@@ -493,7 +493,7 @@
/**
* Gets an ID that can be permanently associated with this person.
*
- * @return {String} The ID
+ * @return {string} The ID
*/
opensocial.Person.prototype.getId = function() {
return this.getField(opensocial.Person.Field.ID);
@@ -511,7 +511,7 @@
* Gets a text display name for this person; guaranteed to return
* a useful string.
*
- * @return {String} The display name
+ * @return {string} The display name
*/
opensocial.Person.prototype.getDisplayName = function() {
var name = this.getField(opensocial.Person.Field.NAME);
@@ -541,14 +541,14 @@
/**
* Gets data for this person that is associated with the specified key.
*
- * @param {String} key The key to get data for;
+ * @param {string} key The key to get data for;
* keys are defined in <a href="opensocial.Person.Field.html"><code>
* Person.Field</code></a>
- * @param {Map.<opensocial.DataRequest.DataRequestFields, Object>}
+ * @param {Object.<opensocial.DataRequest.DataRequestFields, Object>=}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {String} The data
+ * @return {string} The data
*/
opensocial.Person.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
@@ -559,8 +559,8 @@
* Gets the app data for this person that is associated with the specified
* key.
*
- * @param {String} key The key to get app data for.
- * @return {String} The corresponding app data.
+ * @param {string} key The key to get app data for.
+ * @return {string} The corresponding app data.
*/
opensocial.Person.prototype.getAppData = function(key) {
};
@@ -569,7 +569,7 @@
/**
* Returns true if this person object represents the currently logged in user.
*
- * @return {Boolean} True if this is the currently logged in user;
+ * @return {boolean} True if this is the currently logged in user;
* otherwise, false
*/
opensocial.Person.prototype.isViewer = function() {
@@ -580,7 +580,7 @@
/**
* Returns true if this person object represents the owner of the current page.
*
- * @return {Boolean} True if this is the owner of the page;
+ * @return {boolean} True if this is the owner of the page;
* otherwise, false
*/
opensocial.Person.prototype.isOwner = function() {
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/phone.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/phone.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/phone.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/phone.js Wed Jan 13 20:57:30 2010
@@ -72,14 +72,14 @@
/**
* Gets data for this phone that is associated with the specified key.
*
- * @param {String} key The key to get data for;
+ * @param {string} key The key to get data for;
* keys are defined in <a href="opensocial.Phone.Field.html"><code>
* Phone.Field</code></a>
- * @param {Map.<opensocial.DataRequest.DataRequestFields, Object>}
+ * @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {String} The data
+ * @return {string} The data
*/
opensocial.Phone.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/responseitem.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/responseitem.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/responseitem.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/responseitem.js Wed Jan 13 20:57:30 2010
@@ -53,7 +53,7 @@
/**
* Returns true if there was an error in fetching this data from the server.
*
- * @return {Boolean} True if there was an error; otherwise, false
+ * @return {boolean} True if there was an error; otherwise, false
*/
opensocial.ResponseItem.prototype.hadError = function() {
return !!this.errorCode_;
@@ -125,7 +125,7 @@
* or one of the values defined by
* <a href="opensocial.ResponseItem.Error.html"><code>Error</code></a>.
*
- * @return {String} The error code, or null if no error occurred
+ * @return {string} The error code, or null if no error occurred
*/
opensocial.ResponseItem.prototype.getErrorCode = function() {
return this.errorCode_;
@@ -135,7 +135,7 @@
/**
* If the request had an error, returns the error message.
*
- * @return {String} A human-readable description of the error that occurred;
+ * @return {string} A human-readable description of the error that occurred;
* can be null, even if an error occurred
*/
opensocial.ResponseItem.prototype.getErrorMessage = function() {
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/url.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/url.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/url.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-reference/url.js Wed Jan 13 20:57:30 2010
@@ -79,14 +79,14 @@
/**
* Gets data for this URL that is associated with the specified key.
*
- * @param {String} key The key to get data for;
+ * @param {string} key The key to get data for;
* keys are defined in <a href="opensocial.Url.Field.html"><code>
* Url.Field</code></a>
- * @param {Map.<opensocial.DataRequest.DataRequestFields, Object>}
+ * @param {Object.<opensocial.DataRequest.DataRequestFields, Object>}
* opt_params Additional
* <a href="opensocial.DataRequest.DataRequestFields.html">params</a>
* to pass to the request.
- * @return {String} The data
+ * @return {string} The data
*/
opensocial.Url.prototype.getField = function(key, opt_params) {
return opensocial.Container.getField(this.fields_, key, opt_params);
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/base.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/base.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/base.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/base.js Wed Jan 13 20:57:30 2010
@@ -109,7 +109,7 @@
* Preprocess the template.
* @param {Element|TextNode|string} node DOM node containing the template data, or the
* string source.
- * @param {string} opt_id An optional ID for the new template.
+ * @param {string=} opt_id An optional ID for the new template.
* @return {os.Template} A compiled Template object
*/
os.compileTemplate = function(node, opt_id) {
@@ -133,8 +133,8 @@
/**
* Compile a template without requiring a DOM node.
* @param {string} src XML data to be compiled.
- * @param {string} opt_id An optional ID for the new template.
- * @param {Element} opt_container An optional container DOM Element
+ * @param {string=} opt_id An optional ID for the new template.
+ * @param {Element=} opt_container An optional container DOM Element
* to look for namespaces
* @return {opensocial.template.Template} A compiled Template object.
*/
@@ -220,7 +220,7 @@
* Creates a functor which returns a value from the specified node given a
* name.
* @param {Node} node Node to get the value from.
- * @return {Function} The functor which takes a type {string}.
+ * @return {function(string)} The functor which takes a type {string}.
* @private
*/
os.createNodeAccessor_ = function(node) {
@@ -265,7 +265,7 @@
* Registers a custom attribute functor. When this attribute is encountered in
* a DOM node, the specified functor will be called.
* @param {string} attrName The name of the custom attribute.
- * @param {Function} functor A function with signature
+ * @param {function(string)} functor A function with signature
* function({Element}, {string}, {Object}, {JSEvalContext})
*/
os.registerAttribute_ = function(attrName, functor) {
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/compiler.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/compiler.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/compiler.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/compiler.js Wed Jan 13 20:57:30 2010
@@ -41,7 +41,7 @@
* Takes an XML node containing Template markup and compiles it into a Template.
* The node itself is not considered part of the markup.
* @param {Node} node XML node to be compiled.
- * @param {string} opt_id An optional ID for the new template.
+ * @param {string=} opt_id An optional ID for the new template.
* @return {os.Template} A compiled Template object.
*/
os.compileXMLNode = function(node, opt_id) {
@@ -67,7 +67,7 @@
/**
* Takes an XML Document and compiles it into a Template object.
* @param {Document} doc XML document to be compiled.
- * @param {string} opt_id An optional ID for the new template.
+ * @param {string=} opt_id An optional ID for the new template.
* @return {os.Template} A compiled Template object.
*/
os.compileXMLDoc = function(doc, opt_id) {
@@ -147,7 +147,7 @@
/**
* Replace the top level variables
- * @param {string} expr The expression
+ * @param {string} text The expression
* @return {string} Expression with replacements
*/
os.replaceTopLevelVars_ = function(text) {
@@ -200,8 +200,8 @@
* TODO: This should not be in compiler.
*
* @param {JsEvalContext|Object} context Context to get property from
- * @param {String} name Name of the property
- * @return {Object|String}
+ * @param {string} name Name of the property
+ * @return {Object|string}
*/
os.getFromContext = function(context, name, opt_default) {
if (!context) {
@@ -253,7 +253,7 @@
/**
* Prepares an expression for JS evaluation.
* @param {string} expr The expression snippet to parse.
- * @param {string} opt_default An optional default value reference (such as the
+ * @param {string=} opt_default An optional default value reference (such as the
* literal string 'null').
*/
os.transformExpression_ = function(expr, opt_default) {
@@ -293,7 +293,7 @@
* counterparts.
* @param {Element} from An XML or HTML node to copy attributes from.
* @param {Element} to An HTML node to copy attributes to.
- * @param {String} opt_customTag The name of the custom tag, being processed if
+ * @param {string=} opt_customTag The name of the custom tag, being processed if
* any.
*
* TODO(levik): On IE, some properties/attributes might be case sensitive when
@@ -592,8 +592,8 @@
* Removes extra whitespace and newline characters for IE - to be used for
* transforming strings that are destined for textNode content.
* @param {string} string The string to trim spaces from.
- * @param {boolean} opt_trimStart Trim the start of the string.
- * @param {boolean} opt_trimEnd Trim the end of the string.
+ * @param {boolean=} opt_trimStart Trim the start of the string.
+ * @param {boolean=} opt_trimEnd Trim the end of the string.
* @return {string} The string with extra spaces removed on IE, original
* string on other browsers.
*/
@@ -808,8 +808,8 @@
* os.VAR_idenfitierresolver ("$_ir") is used as the function name.
* So, "foo.bar" becomes "$_ir($_ir($context, 'foo'), 'bar')"
* @param {string} iden A string representing an identifier.
- * @param {string} opt_context A string expression to use for context.
- * @param {string} opt_default An optional default value reference (such as the
+ * @param {string=} opt_context A string expression to use for context.
+ * @param {string=} opt_default An optional default value reference (such as the
* literal string 'null').
*/
os.wrapSingleIdentifier = function(iden, opt_context, opt_default) {
@@ -875,7 +875,7 @@
* Wraps all identifiers in a JS expression. The expression is tokenized, then
* each token is wrapped individually.
* @param {string} expr The expression to wrap.
- * @param {string} opt_default An optional default value reference (such as the
+ * @param {string=} opt_default An optional default value reference (such as the
* literal string 'null').
*/
os.wrapIdentifiersInExpression = function(expr, opt_default) {
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/container.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/container.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/container.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/container.js Wed Jan 13 20:57:30 2010
@@ -153,7 +153,7 @@
* Compiles and registers all DOM elements in the document. Templates are
* registered as tags if they specify their name with the "tag" attribute
* and as templates if they have a name (or id) attribute.
- * @param {Object} opt_doc Optional document to use rather than the global doc.
+ * @param {Object=} opt_doc Optional document to use rather than the global doc.
*/
os.Container.registerDocumentTemplates = function(opt_doc) {
var doc = opt_doc || document;
@@ -173,8 +173,8 @@
/**
* Compiles and registers all unnamed templates in the document.
- * @param {Object} opt_data Optional JSON data.
- * @param {Object} opt_doc Optional document to use instead of window.document.
+ * @param {Object=} opt_data Optional JSON data.
+ * @param {Object=} opt_doc Optional document to use instead of window.document.
*/
os.Container.compileInlineTemplates = function(opt_data, opt_doc) {
var doc = opt_doc || document;
@@ -210,7 +210,7 @@
/**
* Renders any registered inline templates.
- * @param {Object} opt_doc Optional document to use instead of window.document.
+ * @param {Object=} opt_doc Optional document to use instead of window.document.
*/
os.Container.renderInlineTemplates = function(opt_doc) {
var doc = opt_doc || document;
@@ -271,8 +271,8 @@
* optional data.
* @param {Object} template The template object to use.
* @param {Element} element The DOM element to inject the template into.
-* @param {Object} opt_data Optional data to be used as to create a context.
-* @param {Object} opt_context Optional pre-constructed rendering context.
+* @param {Object=} opt_data Optional data to be used as to create a context.
+* @param {Object=} opt_context Optional pre-constructed rendering context.
* @return {Function} The constructed closure.
* TODO(davidbyttow): Move this into util.js
*/
@@ -330,7 +330,7 @@
* Renders a DOM element with a specified template and contextual data.
* @param {string} elementId Id of DOM element to inject into.
* @param {string} templateId Id of the template.
- * @param {Object} opt_data Data to supply to template.
+ * @param {Object=} opt_data Data to supply to template.
*/
os.Container.renderElement = function(elementId, templateId, opt_data) {
var template = os.getTemplate(templateId);
@@ -348,7 +348,7 @@
/**
* Compiles and renders all inline templates.
- * @param {Object} opt_doc Optional document to use instead of window.document.
+ * @param {Object=} opt_doc Optional document to use instead of window.document.
*/
os.Container.processInlineTemplates = function(opt_doc) {
os.Container.compileInlineTemplates(opt_doc);
@@ -397,8 +397,8 @@
/**
* Utility method which will automatically register all templates
* and render all that are inline.
- * @param {Object} opt_data Optional JSON object to render templates against
- * @param {Document} opt_doc Optional document to use instead of window.document
+ * @param {Object=} opt_data Optional JSON object to render templates against
+ * @param {Document=} opt_doc Optional document to use instead of window.document
*/
os.Container.processDocument = function(opt_data, opt_doc) {
if (os.Container.requiredLibraries_ > 0) {
@@ -472,7 +472,7 @@
/**
* Compiles and registers a template from a DOM element.
* @param {Element} element DOM element from which to create a template.
- * @param {string} opt_id Optional id for template.
+ * @param {string=} opt_id Optional id for template.
* @return {Object} The compiled and registered template object.
* @private
*/
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/jsTemplate/jsevalcontext.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/jsTemplate/jsevalcontext.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/jsTemplate/jsevalcontext.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/jsTemplate/jsevalcontext.js Wed Jan 13 20:57:30 2010
@@ -56,8 +56,8 @@
/**
* See constructor_()
- * @param {Object|null} opt_data
- * @param {Object} opt_parent
+ * @param {Object|null=} opt_data
+ * @param {Object=} opt_parent
* @constructor
*/
function JsEvalContext(opt_data, opt_parent) {
@@ -69,9 +69,9 @@
* object, whose properties can be referred to in jstemplate
* expressions, and it holds the locally defined variables.
*
- * @param {Object|null} opt_data The context object. Null if no context.
+ * @param {Object|null=} opt_data The context object. Null if no context.
*
- * @param {Object} opt_parent The parent context, from which local
+ * @param {Object=} opt_parent The parent context, from which local
* variables are inherited. Normally the context object of the parent
* context is the object whose property the parent object is. Null for the
* context of the root object.
@@ -184,8 +184,8 @@
* A factory to create a JsEvalContext instance, possibly reusing
* one from recycledInstances_. (IE6 perf)
*
- * @param {Object} opt_data
- * @param {JsEvalContext} opt_parent
+ * @param {Object=} opt_data
+ * @param {JsEvalContext=} opt_parent
* @return {JsEvalContext}
*/
JsEvalContext.create = function(opt_data, opt_parent) {
@@ -302,7 +302,7 @@
* and returns the result.
*
* @param {string} expr A javascript expression
- * @param {Element} opt_template An optional node to serve as "this"
+ * @param {Element=} opt_template An optional node to serve as "this"
*
* @return {Object?} value
*/
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/jsTemplate/jstemplate.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/jsTemplate/jstemplate.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/jsTemplate/jstemplate.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/jsTemplate/jstemplate.js Wed Jan 13 20:57:30 2010
@@ -99,7 +99,7 @@
* template that, if processed again with the same data, will remain
* unchanged.
*
- * @param {boolean} opt_debugging Optional flag to collect debugging
+ * @param {boolean=} opt_debugging Optional flag to collect debugging
* information while processing the template. Only takes effect
* in MAPS_DEBUG.
*/
@@ -872,7 +872,7 @@
* returning the template.
*
* @param {string} name The ID of the HTML element used as template.
- * @param {Function} opt_loadHtmlFn A function which, when called, will return
+ * @param {Function=} opt_loadHtmlFn A function which, when called, will return
* HTML that contains an element whose ID is 'name'.
*
* @return {Element|null} The DOM node of the template. (Only element nodes
@@ -901,7 +901,7 @@
* does not exist, throw an exception.
*
* @param {string} name The ID of the HTML element used as template.
- * @param {Function} opt_loadHtmlFn A function which, when called, will return
+ * @param {Function=} opt_loadHtmlFn A function which, when called, will return
* HTML that contains an element whose ID is 'name'.
*
* @return {Element} The DOM node of the template. (Only element nodes
@@ -922,7 +922,7 @@
* @param {string} name
* @param {Function} loadHtmlFn A function that returns HTML to be inserted
* into the DOM.
- * @param {string} opt_target The id of a DOM object under which to attach the
+ * @param {string=} opt_target The id of a DOM object under which to attach the
* HTML once it's inserted. An object with this id is created if it does not
* exist.
* @return {Element} The node whose id is 'name'
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/jsTemplate/util.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/jsTemplate/util.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/jsTemplate/util.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/jsTemplate/util.js Wed Jan 13 20:57:30 2010
@@ -123,7 +123,7 @@
*
* @param {Array} array Array to be sliced.
* @param {number} start The start of the slice.
- * @param {number} opt_end The end of the slice (optional).
+ * @param {number=} opt_end The end of the slice (optional).
* @return {Array} array The slice of the array from start to end.
*/
function arraySlice(array, start, opt_end) {
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/os.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/os.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/os.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/os.js Wed Jan 13 20:57:30 2010
@@ -131,7 +131,7 @@
* @param {Object} object The object in the scope of which to get a named
* property.
* @param {string} name The name of the property to get.
- * @return {Object?} The property requested.
+ * @return {Object?|undefined} The property requested.
*/
os.resolveOpenSocialIdentifier = function(object, name) {
// Simple property from object.
Modified: incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/template.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/template.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/template.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/opensocial-templates/template.js Wed Jan 13 20:57:30 2010
@@ -24,6 +24,8 @@
/**
* Creates a context object out of a json data object.
+ * @param {Object} data
+ * @param {Object=} opt_globals
*/
os.createContext = function(data, opt_globals) {
var context = JsEvalContext.create(data);
@@ -112,7 +114,7 @@
/**
* Sets a single compiled node into this template.
- * @param node {Element} A compiled node.
+ * @param {Element} node - A compiled node.
*/
os.Template.prototype.setCompiledNode_ = function(node) {
os.removeChildren(this.templateRoot_);
@@ -121,7 +123,7 @@
/**
* Sets a list of compiled nodes into this template.
- * @param nodes {Array.Element} An array of compiled nodes.
+ * @param {Array.<Element>} nodes An array of compiled nodes.
*/
os.Template.prototype.setCompiledNodes_ = function(nodes) {
os.removeChildren(this.templateRoot_);
Modified: incubator/shindig/trunk/features/src/main/javascript/features/osapi/batch.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/osapi/batch.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/osapi/batch.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/osapi/batch.js Wed Jan 13 20:57:30 2010
@@ -43,7 +43,7 @@
/**
* Create a new request in the batch
* @param {string} key id for the request
- * @param {object} request the opensocial request object which is of the form
+ * @param {Object} request the opensocial request object which is of the form
* { method : <service-method>
* rpc : <request>
* transport : <rpc dispatcher>
@@ -58,7 +58,7 @@
/**
* Convert our internal request format into a JSON-RPC
- * @param request
+ * @param {Object} request
*/
var toJsonRpc = function(request) {
var jsonRpc = {method : request.request.method, id : request.key};
@@ -73,7 +73,7 @@
* bound transports and then merge them before calling the userCallback. If the result
* of an rpc is another rpc request then it will be chained and executed.
*
- * @param {Function} userCallback the callback to the gadget where results are passed.
+ * @param {function(Object)} userCallback the callback to the gadget where results are passed.
*/
var execute = function(userCallback) {
var batchResult = {};
Modified: incubator/shindig/trunk/features/src/main/javascript/features/osapi/gadgetsrpctransport.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/osapi/gadgetsrpctransport.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/osapi/gadgetsrpctransport.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/osapi/gadgetsrpctransport.js Wed Jan 13 20:57:30 2010
@@ -30,7 +30,7 @@
* the method osapi._handleGadgetRpcMethod(<JSON-RPC batch>)
*
* @param {object} requests the opensocial JSON-RPC request batch
- * @param {Function} callback to the osapi batch with either an error response or
+ * @param {function(Object)} callback to the osapi batch with either an error response or
* a JSON-RPC batch result
* @private
*/
Modified: incubator/shindig/trunk/features/src/main/javascript/features/osapi/jsonrpctransport.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/osapi/jsonrpctransport.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/osapi/jsonrpctransport.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/osapi/jsonrpctransport.js Wed Jan 13 20:57:30 2010
@@ -24,8 +24,8 @@
/**
* Called by a batch to execute all requests
- * @param requests
- * @param callback
+ * @param {Object} requests
+ * @param {function(Object)} callback
*/
function execute(requests, callback) {
Modified: incubator/shindig/trunk/features/src/main/javascript/features/osapi/osapi.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/osapi/osapi.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/osapi/osapi.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/osapi/osapi.js Wed Jan 13 20:57:30 2010
@@ -22,8 +22,8 @@
/**
* Called by the transports for each service method that they expose
- * @param method The method to expose e.g. "people.get"
- * @param transport The transport used to execute a call for the method
+ * @param {string} method The method to expose e.g. "people.get"
+ * @param {Object.<String,Object>} transport The transport used to execute a call for the method
*/
osapi._registerMethod = function (method, transport) {
var parts = method.split(".");
Modified: incubator/shindig/trunk/features/src/main/javascript/features/pubsub/pubsub-router.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/pubsub/pubsub-router.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/pubsub/pubsub-router.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/pubsub/pubsub-router.js Wed Jan 13 20:57:30 2010
@@ -77,10 +77,10 @@
return /** @scope gadgets.pubsubrouter */ {
/**
* Initializes the PubSub message router.
- * @param {function} gadgetIdToSpecUrlHandler Function that returns the full
+ * @param {function(number)} gadgetIdToSpecUrlHandler Function that returns the full
* gadget spec URL of a given gadget id. For example:
* function(id) { return idToUrlMap[id]; }
- * @param {object} opt_callbacks Optional event handlers. Supported handlers:
+ * @param {object=} opt_callbacks Optional event handlers. Supported handlers:
* opt_callbacks.onSubscribe: function(gadgetId, channel)
* Called when a gadget tries to subscribe to a channel.
* opt_callbacks.onUnsubscribe: function(gadgetId, channel)
Modified: incubator/shindig/trunk/features/src/main/javascript/features/pubsub/pubsub.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/pubsub/pubsub.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/pubsub/pubsub.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/pubsub/pubsub.js Wed Jan 13 20:57:30 2010
@@ -50,7 +50,7 @@
/**
* Subscribes to a channel.
* @param {string} channel Channel name.
- * @param {function} callback Callback function that receives messages.
+ * @param {function(Object,Object)} callback Callback function that receives messages.
* For example:
* function(sender, message) {
* if (isTrustedGadgetSpecUrl(sender)) {
Modified: incubator/shindig/trunk/features/src/main/javascript/features/rpc/ifpc.transport.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/rpc/ifpc.transport.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/rpc/ifpc.transport.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/rpc/ifpc.transport.js Wed Jan 13 20:57:30 2010
@@ -46,7 +46,7 @@
* Encodes arguments for the legacy IFPC wire format.
*
* @param {Object} args
- * @return {String} the encoded args
+ * @return {string} the encoded args
*/
function encodeLegacyData(args) {
var argsEscaped = [];
@@ -58,7 +58,7 @@
/**
* Helper function to emit an invisible IFrame.
- * @param {String} src SRC attribute of the IFrame to emit.
+ * @param {string} src SRC attribute of the IFrame to emit.
* @private
*/
function emitInvisibleIframe(src) {
Modified: incubator/shindig/trunk/features/src/main/javascript/features/rpc/rmr.transport.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/rpc/rmr.transport.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/rpc/rmr.transport.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/rpc/rmr.transport.js Wed Jan 13 20:57:30 2010
@@ -62,10 +62,10 @@
* Append an RMR relay frame to the document. This allows the receiver
* to start receiving messages.
*
- * @param {object} channelFrame Relay frame to add to the DOM body.
+ * @param {Node} channelFrame Relay frame to add to the DOM body.
* @param {string} relayUri Base URI for the frame.
- * @param {string} Data to pass along to the frame.
- * @param {string} opt_frameId ID of frame for which relay is being appended.
+ * @param {string} data to pass along to the frame.
+ * @param {string=} opt_frameId ID of frame for which relay is being appended (optional).
*/
function appendRmrFrame(channelFrame, relayUri, data, opt_frameId) {
var appendFn = function() {
@@ -240,9 +240,9 @@
* method. If this method fails, the system attempts again
* using the known default of IFPC.
*
- * @param {String} targetId Module Id of the RPC service provider.
- * @param {String} serviceName Name of the service to call.
- * @param {String} from Module Id of the calling provider.
+ * @param {string} targetId Module Id of the RPC service provider.
+ * @param {string} serviceName Name of the service to call.
+ * @param {string} from Module Id of the calling provider.
* @param {Object} rpc The RPC data for this call.
*/
function callRmr(targetId, serviceName, from, rpc) {
Modified: incubator/shindig/trunk/features/src/main/javascript/features/rpc/rpc.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/rpc/rpc.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/rpc/rpc.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/rpc/rpc.js Wed Jan 13 20:57:30 2010
@@ -378,11 +378,9 @@
* This works when gadgets are rendered on the same domain as their container,
* a potentially useful optimization for trusted content which keeps
* RPC behind a consistent interface.
- * @param {String} target Module id of the rpc service provider
- * @param {String} from Module id of the caller (this)
- * @param {String} callbackId Id of the call
- * @param {String} rpcData JSON-encoded RPC payload
- * @return
+ * @param {string} target Module id of the rpc service provider
+ * @param {Object} rpc RPC data
+ * @return {boolean}
*/
function callSameDomain(target, rpc) {
if (typeof sameDomain[target] === 'undefined') {
@@ -415,6 +413,11 @@
return false;
}
+ /**
+ * @param {string} targetId
+ * @param {string} url
+ * @param {boolean=} opt_useLegacy
+ */
function setRelayUrl(targetId, url, opt_useLegacy) {
relayUrl[targetId] = url;
useLegacyProtocol[targetId] = !!opt_useLegacy;
@@ -517,6 +520,11 @@
setAuthToken(gadgetId, rpctoken);
}
+ /**
+ * @param {string} targetId
+ * @param {string=} opt_receiverurl
+ * @param {string=} opt_authtoken
+ */
function setupReceiver(targetId, opt_receiverurl, opt_authtoken) {
if (targetId === '..') {
// Gadget/IFRAME to container.
@@ -535,8 +543,8 @@
return /** @scope gadgets.rpc */ {
/**
* Registers an RPC service.
- * @param {String} serviceName Service name to register.
- * @param {Function} handler Service handler.
+ * @param {string} serviceName Service name to register.
+ * @param {function(Object,Object)} handler Service handler.
*
* @member gadgets.rpc
*/
@@ -555,7 +563,7 @@
/**
* Unregisters an RPC service.
- * @param {String} serviceName Service name to unregister.
+ * @param {string} serviceName Service name to unregister.
*
* @member gadgets.rpc
*/
@@ -575,7 +583,7 @@
/**
* Registers a default service handler to processes all unknown
* RPC calls which raise an exception by default.
- * @param {Function} handler Service handler.
+ * @param {function(Object,Object)} handler Service handler.
*
* @member gadgets.rpc
*/
@@ -607,10 +615,10 @@
/**
* Calls an RPC service.
- * @param {String} targetId Module Id of the RPC service provider.
+ * @param {string} targetId Module Id of the RPC service provider.
* Empty if calling the parent container.
- * @param {String} serviceName Service name to call.
- * @param {Function|null} callback Callback function (if any) to process
+ * @param {string} serviceName Service name to call.
+ * @param {function()|null} callback Callback function (if any) to process
* the return value of the RPC request.
* @param {*} var_args Parameters for the RPC request.
*
@@ -680,8 +688,8 @@
/**
* Gets the relay URL of a target frame.
- * @param {String} targetId Name of the target frame.
- * @return {String|undefined} Relay URL of the target frame.
+ * @param {string} targetId Name of the target frame.
+ * @return {string|undefined} Relay URL of the target frame.
*
* @member gadgets.rpc
*/
@@ -697,9 +705,9 @@
/**
* Sets the relay URL of a target frame.
- * @param {String} targetId Name of the target frame.
- * @param {String} url Full relay URL of the target frame.
- * @param {Boolean} opt_useLegacy True if this relay needs the legacy IFPC
+ * @param {string} targetId Name of the target frame.
+ * @param {string} url Full relay URL of the target frame.
+ * @param {boolean=} opt_useLegacy True if this relay needs the legacy IFPC
* wire format.
*
* @member gadgets.rpc
@@ -709,8 +717,8 @@
/**
* Sets the auth token of a target frame.
- * @param {String} targetId Name of the target frame.
- * @param {String} token The authentication token to use for all
+ * @param {string} targetId Name of the target frame.
+ * @param {string} token The authentication token to use for all
* calls to or from this target id.
*
* @member gadgets.rpc
@@ -760,7 +768,7 @@
/**
* Gets the RPC relay mechanism.
- * @return {String} RPC relay mechanism. See above for
+ * @return {string} RPC relay mechanism. See above for
* a list of supported types.
*
* @member gadgets.rpc
@@ -772,7 +780,7 @@
/**
* Receives and processes an RPC request. (Not to be used directly.)
* Only used by IFPC.
- * @param {Array.<String>} fragment An RPC request fragment encoded as
+ * @param {Array.<string>} fragment An RPC request fragment encoded as
* an array. The first 4 elements are target id, source id & call id,
* total packet number, packet id. The last element stores the actual
* JSON-encoded and URI escaped packet data.
Modified: incubator/shindig/trunk/features/src/main/javascript/features/setprefs/setprefs.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/setprefs/setprefs.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/setprefs/setprefs.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/setprefs/setprefs.js Wed Jan 13 20:57:30 2010
@@ -25,8 +25,8 @@
/**
* Stores a preference.
- * @param {String | Object} key The pref to store.
- * @param {String} val The values to store.
+ * @param {string | Object} key The pref to store.
+ * @param {string} value The values to store.
* @private This feature is documented in prefs.js
*/
gadgets.Prefs.prototype.set = function(key, value) {
@@ -60,8 +60,8 @@
/**
* Stores a preference from the given list.
- * @param {String} key The pref to store.
- * @param {Array.<String | Number>} val The values to store.
+ * @param {string} key The pref to store.
+ * @param {Array.<string | number>} val The values to store.
* @private This feature is documented in prefs.js
*/
gadgets.Prefs.prototype.setArray = function(key, val) {
Modified: incubator/shindig/trunk/features/src/main/javascript/features/settitle/settitle.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/settitle/settitle.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/settitle/settitle.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/settitle/settitle.js Wed Jan 13 20:57:30 2010
@@ -28,7 +28,7 @@
/**
* Sets the gadget title.
- * @param {String} title The preferred title.
+ * @param {string} title The preferred title.
* @scope gadgets.window
*/
gadgets.window.setTitle = function(title) {
Modified: incubator/shindig/trunk/features/src/main/javascript/features/skins/skins.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/skins/skins.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/skins/skins.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/skins/skins.js Wed Jan 13 20:57:30 2010
@@ -53,10 +53,10 @@
/**
* Fetches the display property mapped to the given key.
*
- * @param {String} propertyKey The key to get data for;
+ * @param {string} propertyKey The key to get data for;
* keys are defined in <a href="gadgets.skins.Property.html"><code>
* gadgets.skins.Property</code></a>
- * @return {String} The data
+ * @return {string} The data
*
* @member gadgets.skins
*/
Modified: incubator/shindig/trunk/features/src/main/javascript/features/tabs/tabs.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/tabs/tabs.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/tabs/tabs.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/tabs/tabs.js Wed Jan 13 20:57:30 2010
@@ -51,7 +51,7 @@
/**
* Returns the label of the tab as a string (may contain HTML).
- * @return {String} Label of the tab.
+ * @return {string} Label of the tab.
*/
gadgets.Tab.prototype.getName = function() {
return this.td_.innerHTML;
@@ -75,7 +75,7 @@
/**
* Returns the callback function that is executed when the tab is selected.
- * @return {Function} The callback function of the tab.
+ * @return {function(string)} The callback function of the tab.
*/
gadgets.Tab.prototype.getCallback = function() {
return this.callback_;
@@ -83,7 +83,7 @@
/**
* Returns the tab's index.
- * @return {Number} The tab's index.
+ * @return {number} The tab's index.
*/
gadgets.Tab.prototype.getIndex = function() {
var tabs = this.handle_.getTabs();
@@ -99,12 +99,12 @@
* @class A class gadgets can use to make tabs.
* @description Creates a new TabSet object
*
- * @param {String} opt_moduleId Optional suffix for the ID of tab container.
- * @param {String} opt_defaultTab Optional tab name that specifies the name of
+ * @param {string=} opt_moduleId Optional suffix for the ID of tab container.
+ * @param {string=} opt_defaultTab Optional tab name that specifies the name of
* of the tab that is selected after initialization.
* If this parameter is omitted, the first tab is selected by
* default.
- * @param {Element} opt_container The HTML element to contain the tabs. If
+ * @param {Element=} opt_container The HTML element to contain the tabs. If
* omitted, a new div element is created and inserted at the
* very top.
*/
@@ -175,8 +175,8 @@
/**
* Adds a new tab based on the name-value pairs specified in opt_params.
- * @param {String} tabName Label of the tab to create.
- * @param {Object} opt_params Optional parameter object. The following
+ * @param {string} tabName Label of the tab to create.
+ * @param {string|Object=} opt_params Optional parameter object. The following
* properties are supported:
* .contentContainer An existing HTML element to be used as
* the tab content container. If omitted, the tabs
@@ -187,7 +187,7 @@
* the mouse cursor over the tab.
* .index The index at which to insert the tab. If omitted,
* the new tab is appended to the end.
- * @return {String} DOM id of the tab container.
+ * @return {string} DOM id of the tab container.
*/
gadgets.TabSet.prototype.addTab = function(tabName, opt_params) {
if (typeof opt_params === 'string') {
@@ -240,7 +240,7 @@
/**
* Removes a tab at tabIndex and all of its associated content.
- * @param {Number} tabIndex Index of the tab to remove.
+ * @param {number} tabIndex Index of the tab to remove.
*/
gadgets.TabSet.prototype.removeTab = function(tabIndex) {
var tab = this.tabs_[tabIndex];
@@ -279,7 +279,7 @@
/**
* Selects the tab at tabIndex and fires the tab's callback function if it
* exists. If the tab is already selected, the callback is not fired.
- * @param {Number} tabIndex Index of the tab to select.
+ * @param {number} tabIndex Index of the tab to select.
*/
gadgets.TabSet.prototype.setSelectedTab = function(tabIndex) {
if (this.tabs_[tabIndex]) {
@@ -290,8 +290,8 @@
/**
* Swaps the positions of tabs at tabIndex1 and tabIndex2. The selected tab
* does not change, and no callback functions are called.
- * @param {Number} tabIndex1 Index of the first tab to swap.
- * @param {Number} tabIndex2 Index of the secnod tab to swap.
+ * @param {number} tabIndex1 Index of the first tab to swap.
+ * @param {number} tabIndex2 Index of the secnod tab to swap.
*/
gadgets.TabSet.prototype.swapTabs = function(tabIndex1, tabIndex2) {
var tab1 = this.tabs_[tabIndex1];
@@ -309,7 +309,7 @@
/**
* Returns an array of all existing tab objects.
- * @return {Array.<gadgets.Tab>} Array of all existing tab objects.
+ * @return {Array.<gadgets.Tab>} Array of all existing tab objects.
*/
gadgets.TabSet.prototype.getTabs = function() {
return this.tabs_;
@@ -317,8 +317,8 @@
/**
* Sets the alignment of tabs. Tabs are center-aligned by default.
- * @param {String} align 'left', 'center', or 'right'.
- * @param {Number} opt_offset Optional parameter to set the number of pixels
+ * @param {string} align 'left', 'center', or 'right'.
+ * @param {number=} opt_offset Optional parameter to set the number of pixels
* to offset tabs from the left or right edge. The default
* value is 3px.
*/
@@ -338,7 +338,7 @@
/**
* Shows or hides tabs and all associated content.
- * @param {Boolean} display true to show tabs; false to hide tabs.
+ * @param {boolean} display true to show tabs; false to hide tabs.
*/
gadgets.TabSet.prototype.displayTabs = function(display) {
this.mainContainer_.style.display = display ? 'block' : 'none';
@@ -357,7 +357,7 @@
* content will be appended.
* This container element is created and inserted as the first child of the
* gadget if opt_element is not specified.
- * @param {Element} opt_element Optional HTML container element.
+ * @param {Element=} opt_element Optional HTML container element.
* @return {Element} HTML container element.
*/
gadgets.TabSet.prototype.createMainContainer_ = function(opt_element) {
@@ -378,8 +378,8 @@
/**
* Helper method that expands a class name into two class names.
- * @param {String} label CSS class
- * @return {String} Expanded class names.
+ * @param {string} label CSS class
+ * @return {string} Expanded class names.
*/
gadgets.TabSet.prototype.cascade_ = function(label) {
return label + ' ' + label + this.moduleId_;
@@ -495,6 +495,7 @@
/**
* Helper method that shows or hides the navigation elements.
+ * @private
*/
gadgets.TabSet.prototype.adjustNavigation_ = function() {
this.leftNavContainer_.style.display = 'none';
@@ -521,7 +522,8 @@
/**
* Helper method that smoothly scrolls the tabs container.
* @param {Element} container The tabs container element.
- * @param {Number} distance The amount of pixels to scroll right.
+ * @param {number} distance The amount of pixels to scroll right.
+ * @private
*/
gadgets.TabSet.prototype.smoothScroll_ = function(container, distance) {
var scrollAmount = 10;
@@ -542,7 +544,7 @@
/**
* Helper function that dynamically inserts CSS rules to the page.
- * @param {String} cssText CSS rules to inject
+ * @param {string} cssText CSS rules to inject
* @private
*/
gadgets.TabSet.addCSS_ = function(cssText) {
@@ -561,7 +563,7 @@
/**
* Helper method that creates a new gadgets.Tab object.
- * @param {String} tabName Label of the tab to create.
+ * @param {string} tabName Label of the tab to create.
* @param {Object} params Parameter object. The following properties
* are supported:
* .contentContainer An existing HTML element to be used as
@@ -599,7 +601,7 @@
/**
* Helper method that creates a function to select the specified tab.
* @param {gadgets.Tab} tab The tab to select.
- * @return {Function} Callback function to select the tab.
+ * @return {function()} Callback function to select the tab.
*/
gadgets.TabSet.prototype.setSelectedTabGenerator_ = function(tab) {
return function() { tab.handle_.selectTab_(tab); };
@@ -609,6 +611,7 @@
* Helper method that selects a tab and unselects the previously selected.
* If the tab is already selected, then callback is not executed.
* @param {gadgets.Tab} tab The tab to select.
+ * @private
*/
gadgets.TabSet.prototype.selectTab_ = function(tab) {
if (this.selectedTab_ === tab) {
@@ -634,8 +637,16 @@
// Aliases for legacy code
+/**
+ * @type {gadgets.TabSet}
+ */
var _IG_Tabs = gadgets.TabSet;
_IG_Tabs.prototype.moveTab = _IG_Tabs.prototype.swapTabs;
+
+/**
+ * @param {string} tabName
+ * @param {function()} callback
+ */
_IG_Tabs.prototype.addDynamicTab = function(tabName, callback) {
return this.addTab(tabName, {callback: callback});
};
Modified: incubator/shindig/trunk/features/src/main/javascript/features/views/views.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/views/views.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/views/views.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/views/views.js Wed Jan 13 20:57:30 2010
@@ -137,7 +137,7 @@
* http://bitworking.org/projects/URI-Templates/spec/draft-gregorio-uritemplate-03.html
*
* @param {string} urlTemplate A URL template for a container view.
- * @param {Map<string, string>} environment A set of named variables.
+ * @param {Object.<string, string>} environment A set of named variables.
* @return {string} A URL string with substituted variables.
*/
bind : function(urlTemplate, environment) {
@@ -163,6 +163,10 @@
vars,
flag;
+ /**
+ * @param {string} varName
+ * @param {string=} defaultVal
+ */
function getVar(varName, defaultVal) {
return environment.hasOwnProperty(varName) ?
environment[varName] : defaultVal;
@@ -187,7 +191,7 @@
function objectIsEmpty(v) {
if ((typeof v === 'object') || (typeof v === 'function')) {
- for (i in v) {
+ for (var i in v) {
if (v.hasOwnProperty(i)) {
return false;
}
@@ -229,7 +233,7 @@
if (typeof v === 'string') {
j.push(k + '=' + v);
} else if (typeof v === 'object') {
- for (i in v) {
+ for (var i in v) {
if (v.hasOwnProperty(i)) {
j.push(i + '=' + v[i]);
}
@@ -239,7 +243,7 @@
break;
case 'list':
matchVar(vars);
- value = getVar(match[1]);
+ var value = getVar(match[1]);
if (typeof value === 'object' && typeof value.join === 'function') {
result.push(value.join(arg));
}
@@ -275,9 +279,9 @@
* in the new view.
*
* @param {string | gadgets.views.View} view The view to navigate to
- * @param {Map.<String, String>} opt_params Parameters to pass to the
+ * @param {Object.<string, string>=} opt_params Parameters to pass to the
* gadget after it has been navigated to on the surface
- * @param {string} opt_ownerId The ID of the owner of the page to navigate to;
+ * @param {string=} opt_ownerId The ID of the owner of the page to navigate to;
* defaults to the current owner.
*/
requestNavigateTo : function(view, opt_params, opt_ownerId) {
@@ -300,7 +304,7 @@
* Returns a map of all the supported views. Keys each gadgets.view.View by
* its name.
*
- * @return {Map<gadgets.views.ViewType | String, gadgets.views.View>}
+ * @return {Object.<gadgets.views.ViewType | string, gadgets.views.View>}
* All supported views, keyed by their name attribute.
*/
getSupportedViews : function() {
@@ -312,7 +316,7 @@
* include all url parameters, only the ones passed into
* gadgets.views.requestNavigateTo
*
- * @return {Map.<String, String>} The parameter map
+ * @return {Object.<string, string>} The parameter map
*/
getParams : function() {
return params;
@@ -320,13 +324,27 @@
};
}();
+
+/**
+ * @class
+ * View Class
+ * @name gadgets.views.View
+ */
+
+/**
+ * View Representation
+ * @constructor
+ * @param {string} name - the name of the view
+ * @param {boolean=} opt_isOnlyVisible - is this view devoted to this gadget.
+ */
+
gadgets.views.View = function(name, opt_isOnlyVisible) {
this.name_ = name;
this.isOnlyVisible_ = !!opt_isOnlyVisible;
};
/**
- * @return {String} The view name.
+ * @return {string} The view name.
*/
gadgets.views.View.prototype.getName = function() {
return this.name_;
@@ -348,7 +366,7 @@
/**
* Binds the view's URL template with variables in the passed environment
* to produce a URL string.
- * @param {Map<string, string>} environment A set of named variables.
+ * @param {Object.<string, string>} environment A set of named variables.
* @return {string} A URL string with substituted variables.
*/
gadgets.views.View.prototype.bind = function(environment) {
@@ -356,7 +374,7 @@
};
/**
- * @return {Boolean} True if this is the only visible gadget on the page.
+ * @return {boolean} True if this is the only visible gadget on the page.
*/
gadgets.views.View.prototype.isOnlyVisibleGadget = function() {
return this.isOnlyVisible_;
Modified: incubator/shindig/trunk/features/src/main/javascript/features/xmlutil/xmlutil.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/src/main/javascript/features/xmlutil/xmlutil.js?rev=898941&r1=898940&r2=898941&view=diff
==============================================================================
--- incubator/shindig/trunk/features/src/main/javascript/features/xmlutil/xmlutil.js (original)
+++ incubator/shindig/trunk/features/src/main/javascript/features/xmlutil/xmlutil.js Wed Jan 13 20:57:30 2010
@@ -55,7 +55,7 @@
/**
* Map of Namespace prefixes to their respective URLs.
- * @type Map<string, string>
+ * @type Object.<string,string>
*/
opensocial.xmlutil.NSMAP = {
"os": "http://opensocial.org/"
@@ -69,7 +69,7 @@
* the supplied code. An empty string is returned if no injection is needed.
*
* @param {string} xml XML-like source code.
- * @param {Element} opt_container Optional container node to look for namespace
+ * @param {Element=} opt_container Optional container node to look for namespace
* declarations.
* @return {string} A string of xmlns delcarations required for this XML.
*/
@@ -102,7 +102,7 @@
/**
* Returns a map of XML namespaces declared on an DOM Element.
* @param {Element} el The Element to inspect
- * @return {object(string, string)} A Map of keyed by prefix of declared
+ * @return {Object.<string, string>} A Map of keyed by prefix of declared
* namespaces.
*/
opensocial.xmlutil.getNamespaceDeclarations_ = function(el) {
@@ -130,7 +130,7 @@
* Prepares an XML-like string to be parsed by browser parser. Injects a DOCTYPE
* with entities and a top-level <root> element to encapsulate the code.
* @param {string} xml XML string to be prepared.
- * @param {Element} opt_container Optional container Element with namespace
+ * @param {Element=} opt_container Optional container Element with namespace
* declarations.
* @return {string} XML string prepared for client-side parsing.
*/