svn commit: r949905 - /click/trunk/click/framework/src/org/apache/click/Context.java

[sa...@apache.org]

Author: sabob
Date: Tue Jun  1 00:08:04 2010
New Revision: 949905

URL: http://svn.apache.org/viewvc?rev=949905&view=rev
Log:
javadoc

Modified:
    click/trunk/click/framework/src/org/apache/click/Context.java

Modified: click/trunk/click/framework/src/org/apache/click/Context.java
URL: http://svn.apache.org/viewvc/click/trunk/click/framework/src/org/apache/click/Context.java?rev=949905&r1=949904&r2=949905&view=diff
==============================================================================
--- click/trunk/click/framework/src/org/apache/click/Context.java (original)
+++ click/trunk/click/framework/src/org/apache/click/Context.java Tue Jun  1 00:08:04 2010
@@ -292,17 +292,20 @@ public class Context {
     /**
      * Return true is this is an Ajax request, false otherwise.
      * <p/>
-     * An Ajax request is identified by the presence of the request header or
-     * request parameter: "<tt>X-Requested-With</tt>". This is the de-facto
-     * standard identifier used by Ajax libraries.
-     * <p/>
-     * <b>Note:</b> incoming requests that contains "<tt>X-Requested-With</tt>"
-     * as a request parameter will result in this method returning true. This
-     * allows one to programmatically enable Ajax requests. A common usage of
-     * this feature is when uploading files through an IFrame element. By
-     * specifying "<tt>X-Requested-With</tt>" as a request parameter the IFrame
+     * An Ajax request is identified by the presence of the request <tt>header</tt>
+     * or request <tt>parameter</tt>: "<tt>X-Requested-With</tt>".
+     * "<tt>X-Requested-With</tt>" is the de-facto standard identifier used by
+     * Ajax libraries.
+     * <p/>
+     * <b>Note:</b> incoming requests that contains a request <tt>parameter</tt>
+     * "<tt>X-Requested-With</tt>" will result in this method returning true, even
+     * though the request itself was not initiated through a <tt>XmlHttpRequest</tt>
+     * object. This allows one to programmatically enable Ajax requests. A common
+     * use case for this feature is when uploading files through an IFrame element.
+     * By specifying "<tt>X-Requested-With</tt>" as a request parameter the IFrame
      * request will be handled like a normal Ajax request.
      *
+     * @param request the servlet request
      * @return true if this is an Ajax request, false otherwise
      */
     public boolean isAjaxRequest() {