svn commit: r472370 - /struts/struts2/trunk/core/src/main/java/org/apache/struts2/interceptor/debugging/DebuggingInterceptor.java

[hu...@apache.org]

Author: husted
Date: Tue Nov  7 19:06:03 2006
New Revision: 472370

URL: http://svn.apache.org/viewvc?view=rev&rev=472370
Log:
WW-1279 Add snippet markup. 

Modified:
    struts/struts2/trunk/core/src/main/java/org/apache/struts2/interceptor/debugging/DebuggingInterceptor.java

Modified: struts/struts2/trunk/core/src/main/java/org/apache/struts2/interceptor/debugging/DebuggingInterceptor.java
URL: http://svn.apache.org/viewvc/struts/struts2/trunk/core/src/main/java/org/apache/struts2/interceptor/debugging/DebuggingInterceptor.java?view=diff&rev=472370&r1=472369&r2=472370
==============================================================================
--- struts/struts2/trunk/core/src/main/java/org/apache/struts2/interceptor/debugging/DebuggingInterceptor.java (original)
+++ struts/struts2/trunk/core/src/main/java/org/apache/struts2/interceptor/debugging/DebuggingInterceptor.java Tue Nov  7 19:06:03 2006
@@ -49,9 +49,13 @@
 import com.opensymphony.xwork2.util.ValueStack;
 
 /**
+ * <!-- START SNIPPET: description -->
  * Provides several different debugging screens to provide insight into the
- * data behind the page. The value of the 'debug' request parameter determines
+ * data behind the page.
+ * <!-- END SNIPPET: description -->
+ * The value of the 'debug' request parameter determines
  * the screen:
+ * <!-- START SNIPPET: parameters -->
  * <ul>
  * <li> <code>xml</code> - Dumps the parameters, context, session, and value
  * stack as an XML document.</li>
@@ -61,12 +65,19 @@
  * <li> <code>command</code> - Tests an OGNL expression and returns the
  * string result. Only used by the OGNL console.</li>
  * </ul>
+ * <!-- END SNIPPET: parameters -->
  * <p/>
+ *  Example:
+ * <!-- START SNIPPET: example -->
+ *  http://localhost:8080/Welcome.action?debug=xml
+ * <!-- END SNIPPET: example -->
  * <p/>
+ * <!-- START SNIPPET: remarks -->
  * This interceptor only is activated when devMode is enabled in
  * struts.properties. The 'debug' parameter is removed from the parameter list
  * before the action is executed. All operations occur before the natural
- * Result has a chance to execute. </p>
+ * Result has a chance to execute.
+ * <!-- END SNIPPET: remarks -->
  */
 public class DebuggingInterceptor implements Interceptor {