svn commit: r481075 - /incubator/xap/trunk/src/xap/requestservice/RequestService.js

[mt...@apache.org]

Author: mturyn
Date: Thu Nov 30 12:56:42 2006
New Revision: 481075

URL: http://svn.apache.org/viewvc?view=rev&rev=481075
Log:
Fixed doc bug:  retrieval methods had said they returned strings, instead, they return XMLHttpRequest objects.

Modified:
    incubator/xap/trunk/src/xap/requestservice/RequestService.js

Modified: incubator/xap/trunk/src/xap/requestservice/RequestService.js
URL: http://svn.apache.org/viewvc/incubator/xap/trunk/src/xap/requestservice/RequestService.js?view=diff&rev=481075&r1=481074&r2=481075
==============================================================================
--- incubator/xap/trunk/src/xap/requestservice/RequestService.js (original)
+++ incubator/xap/trunk/src/xap/requestservice/RequestService.js Thu Nov 30 12:56:42 2006
@@ -42,14 +42,13 @@
 }
 
 /**
- * The response content is assumed to be in XML format and is processed 
- * automatically by the client.
+ * The response content is assumed to be an XMLHttpRequest object, which we process.
  * <br><br>
  * Note the given url must be relative to the current application's context path.
  * This is a server-side requirement.
  * 
  * @param url, the url will be relative to the application context path always.
- * @return The retrieved content (String)
+ * @return The retrieved content (XMLHttpRequest)
  * @throws RequestServiceException, a wrapper exception of either a failed 
  * network call or a failed response processing.  Check the 
  * <code>getCausalThrowable()</code> and <code>printStackTrace()</code>
@@ -113,13 +112,13 @@
 
 
 /**
- * Retrieves the content from the specified URL.  
+ * Retrieves the XMLHttpRequest content from the specified URL.  
  * 
  * @param url If there is no leading slash, it's relative to current context 
  * path. If there is a leading slash, it's relative to server; or it needs to be 
  * a full url.
  * 
- * @return The content of the response (String)
+ * @return The content of the response (XMLHttpRequest)
  * @throws RequestServiceException, a wrapper exception. Check the 
  * <code>getCause()</code> method to find out details.
  */