svn commit: r562636 - in /myfaces/trinidad/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/xhr: RequestQueue.js XMLRequestEvent.js

[aw...@apache.org]

Author: awiner
Date: Fri Aug  3 18:05:54 2007
New Revision: 562636

URL: http://svn.apache.org/viewvc?view=rev&rev=562636
Log:
Some simple cleanup for JS documentation

Modified:
    myfaces/trinidad/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/xhr/RequestQueue.js
    myfaces/trinidad/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/xhr/XMLRequestEvent.js

Modified: myfaces/trinidad/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/xhr/RequestQueue.js
URL: http://svn.apache.org/viewvc/myfaces/trinidad/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/xhr/RequestQueue.js?view=diff&rev=562636&r1=562635&r2=562636
==============================================================================
--- myfaces/trinidad/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/xhr/RequestQueue.js (original)
+++ myfaces/trinidad/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/xhr/RequestQueue.js Fri Aug  3 18:05:54 2007
@@ -302,10 +302,10 @@
 * Performs Asynchronous XML HTTP Request with the Server
 * @param context    any object that is sent back to the callback when the request 
 *  is complete. This object can be null.
+* @param method   Javascript method
 * @param actionURL   the url to send the request to
 * @param headerParams  Option HTTP header parameters to attach to the request
 * @param content     the content of the Asynchronous XML HTTP Post
-* @param method   Javascript method
 */
 TrRequestQueue.prototype.sendRequest = function(
   context,

Modified: myfaces/trinidad/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/xhr/XMLRequestEvent.js
URL: http://svn.apache.org/viewvc/myfaces/trinidad/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/xhr/XMLRequestEvent.js?view=diff&rev=562636&r1=562635&r2=562636
==============================================================================
--- myfaces/trinidad/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/xhr/XMLRequestEvent.js (original)
+++ myfaces/trinidad/trunk/trinidad/trinidad-impl/src/main/javascript/META-INF/adf/jsLibs/xhr/XMLRequestEvent.js Fri Aug  3 18:05:54 2007
@@ -18,8 +18,8 @@
  */
 
 /**
- * Data Transfer Request Event class. This object is passed back to the listeners
- * of a Data Transfer Service Request. It support ITrXMLRequestEvent pseudo-interface
+ * AJAX Request Event class. This object is passed back to the listeners
+ * of a AJAX Service Request. It support ITrXMLRequestEvent pseudo-interface
  * with the following methods: getStatus, getResponseXML, getResponseText, 
  * isPprResponse, getResponseContentType
  */
@@ -43,7 +43,7 @@
 }
 
 /**
-* Returns the response of the Data Transfer Request as an XML document
+* Returns the response of the AJAX Request as an XML document
 * NOTE: this method is valid only for TrXMLRequestEvent.STATUS_COMPLETE
 **/
 TrXMLRequestEvent.prototype.getResponseXML = function()
@@ -52,7 +52,7 @@
 }
 
 /**
-* Returns true if the response XML of the Data Transfer Request is valid.
+* Returns true if the response XML of the AJAX Request is valid.
 * NOTE: this method is valid only for TrXMLRequestEvent.STATUS_COMPLETE
 **/
 TrXMLRequestEvent.prototype._isResponseValidXML = function()
@@ -77,7 +77,7 @@
 }
 
 /**
-* Returns the response of the Data Transfer Request as text.
+* Returns the response of the AJAX Request as text.
 * NOTE: this method is valid only for TrXMLRequestEvent.STATUS_COMPLETE
 **/
 TrXMLRequestEvent.prototype.getResponseText = function()
@@ -86,7 +86,7 @@
 }
 
 /**
-* Returns the status code of the xml http Data Transfer Request.
+* Returns the status code of the xml http AJAX Request.
 * NOTE: this method is valid only for TrXMLRequestEvent.STATUS_COMPLETE
 **/
 TrXMLRequestEvent.prototype.getResponseStatusCode = function()
@@ -95,7 +95,7 @@
 }
 
 /**
-* Returns all the response headers for xml http Data Transfer Request.
+* Returns all the response headers for xml http AJAX Request.
 * NOTE: this method is valid only for TrXMLRequestEvent.STATUS_COMPLETE
 **/
 TrXMLRequestEvent.prototype._getAllResponseHeaders = function()
@@ -104,7 +104,7 @@
 }
 
 /**
-* Returns a particular response header for xml http Data Transfer Request.
+* Returns a particular response header for xml http Request.
 * NOTE: this method is valid only for TrXMLRequestEvent.STATUS_COMPLETE
 **/
 TrXMLRequestEvent.prototype.getResponseHeader = function(
@@ -122,6 +122,8 @@
 * Returns if whether if is a rich response
 * NOTE: this method is valid only for TrXMLRequestEvent.STATUS_COMPLETE
 **/
+// TODO: this should likely be deleted or renamed, as it is
+// not PPR-specific here
 TrXMLRequestEvent.prototype.isPprResponse = function()
 {
   // todo: do we need to mark rich responses?