svn commit: r1215475 - /felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java

[fm...@apache.org]

Author: fmeschbe
Date: Sat Dec 17 12:14:02 2011
New Revision: 1215475

URL: http://svn.apache.org/viewvc?rev=1215475&view=rev
Log:
Fix JavaDoc
  - Don't refer to internal class in isHtml JavaDoc
  - Note on isHtml on doGet JavaDoc

Modified:
    felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java

Modified: felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java
URL: http://svn.apache.org/viewvc/felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java?rev=1215475&r1=1215474&r2=1215475&view=diff
==============================================================================
--- felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java (original)
+++ felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java Sat Dec 17 12:14:02 2011
@@ -111,8 +111,8 @@ public abstract class AbstractWebConsole
 
 
     /**
-     * Renders the web console page for the request. This consist of the following
-     * five parts called in order:
+     * Renders the web console page for the request. This consist of the
+     * following five parts called in order:
      * <ol>
      * <li>Send back a requested resource
      * <li>{@link #startResponse(HttpServletRequest, HttpServletResponse)}</li>
@@ -124,9 +124,14 @@ public abstract class AbstractWebConsole
      * <b>Note</b>: If a resource is sent back for the request only the first
      * step is executed. Otherwise the first step is a null-operation actually
      * and the latter four steps are executed in order.
-     * @see javax.servlet.http.HttpServlet#doGet(
-     *  javax.servlet.http.HttpServletRequest,
-     *  javax.servlet.http.HttpServletResponse)
+     * <p>
+     * If the {@link #isHtmlRequest(HttpServletRequest)} method returns
+     * <code>false</code> only the
+     * {@link #renderContent(HttpServletRequest, HttpServletResponse)} method is
+     * called.
+     *
+     * @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest,
+     *      javax.servlet.http.HttpServletResponse)
      */
     protected void doGet( HttpServletRequest request, HttpServletResponse response ) throws ServletException,
         IOException
@@ -160,8 +165,9 @@ public abstract class AbstractWebConsole
     /**
      * Detects whether this request is intended to have the headers and
      * footers of this plugin be rendered or not. This method always returns
-     * <code>true</true> but has been overwritten in the
-     * {@link WebConsolePluginAdapter} for the plugins.
+     * <code>true</true> and may be overwritten by plugins to detect
+     * from the actual request, whether or not to render the header and
+     * footer.
      *
      * @param request the original request passed from the HTTP server
      * @return <code>true</code> if the page should have headers and footers rendered