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/08/30 08:31:06 UTC
svn commit: r990702 - in
/shindig/trunk/features/src/main/javascript/features: core.util/util.js
rpc/nix.transport.js rpc/rpc.js
Author: lindner
Date: Mon Aug 30 06:31:06 2010
New Revision: 990702
URL: http://svn.apache.org/viewvc?rev=990702&view=rev
Log:
minor jsdoc fixes
Modified:
shindig/trunk/features/src/main/javascript/features/core.util/util.js
shindig/trunk/features/src/main/javascript/features/rpc/nix.transport.js
shindig/trunk/features/src/main/javascript/features/rpc/rpc.js
Modified: shindig/trunk/features/src/main/javascript/features/core.util/util.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/core.util/util.js?rev=990702&r1=990701&r2=990702&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/core.util/util.js (original)
+++ shindig/trunk/features/src/main/javascript/features/core.util/util.js Mon Aug 30 06:31:06 2010
@@ -332,9 +332,9 @@ gadgets['util'] = function() {
/**
* Attach an event listener to given DOM element (Not a gadget standard)
*
- * @param {object} elem DOM element on which to attach event.
+ * @param {Object} elem DOM element on which to attach event.
* @param {string} eventName Event type to listen for.
- * @param {function} callback Invoked when specified event occurs.
+ * @param {function()} callback Invoked when specified event occurs.
* @param {boolean} useCapture If true, initiates capture.
*/
'attachBrowserEvent': function(elem, eventName, callback, useCapture) {
@@ -350,9 +350,9 @@ gadgets['util'] = function() {
/**
* Remove event listener. (Shindig internal implementation only)
*
- * @param {object} elem DOM element from which to remove event.
+ * @param {Object} elem DOM element from which to remove event.
* @param {string} eventName Event type to remove.
- * @param {function} callback Listener to remove.
+ * @param {function()} callback Listener to remove.
* @param {boolean} useCapture Specifies whether listener being removed was added with
* capture enabled.
*/
Modified: shindig/trunk/features/src/main/javascript/features/rpc/nix.transport.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/rpc/nix.transport.js?rev=990702&r1=990701&r2=990702&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/rpc/nix.transport.js (original)
+++ shindig/trunk/features/src/main/javascript/features/rpc/nix.transport.js Mon Aug 30 06:31:06 2010
@@ -155,7 +155,7 @@ gadgets.rpctx.nix = function() {
function setupSecureRelayToParent(rpctoken) {
// To the parent, transmit the child's URL, the passed in auth
// token, and another token generated by the child.
- var childToken = (0x7FFFFFFF * Math.random()) | 0; // XXX expose way to have child set this value
+ var childToken = (0x7FFFFFFF * Math.random()) | 0; // TODO expose way to have child set this value
var data = [
getLocationNoHash(),
childToken
Modified: shindig/trunk/features/src/main/javascript/features/rpc/rpc.js
URL: http://svn.apache.org/viewvc/shindig/trunk/features/src/main/javascript/features/rpc/rpc.js?rev=990702&r1=990701&r2=990702&view=diff
==============================================================================
--- shindig/trunk/features/src/main/javascript/features/rpc/rpc.js (original)
+++ shindig/trunk/features/src/main/javascript/features/rpc/rpc.js Mon Aug 30 06:31:06 2010
@@ -657,6 +657,7 @@ gadgets.rpc = function() {
* @param {string} targetId
* @param {string=} opt_receiverurl
* @param {string=} opt_authtoken
+ * @param {string=} opt_forcesecure
*/
function setupReceiver(targetId, opt_receiverurl, opt_authtoken, opt_forcesecure) {
if (targetId === '..') {
@@ -801,10 +802,10 @@ gadgets.rpc = function() {
// Attempt to make call via a cross-domain transport.
// Retrieve the transport for the given target - if one
// target is misconfigured, it won't affect the others.
-// XXX Since 'transport' is always set (on load of rpc.js), channel will never
-// be null (and earlyRpcQueue will never be used). Only use
-// receiverTx[targetId].
-// var channel = receiverTx[targetId] ? receiverTx[targetId] : transport;
+ // TODO Since 'transport' is always set (on load of rpc.js), channel will never
+ // be null (and earlyRpcQueue will never be used). Only use
+ // receiverTx[targetId].
+ // var channel = receiverTx[targetId] ? receiverTx[targetId] : transport;
var channel = receiverTx[targetId];
if (!channel) {
@@ -993,7 +994,6 @@ gadgets.rpc = function() {
LOAD_TIMEOUT: LOAD_TIMEOUT,
FRAME_PHISH: FRAME_PHISH,
FORGED_MSG : FORGED_MSG
-
};
}();