Revision: 1248
          http://stripes.svn.sourceforge.net/stripes/?rev=1248&view=rev
Author:   bengunter
Date:     2010-05-24 14:32:09 +0000 (Mon, 24 May 2010)

Log Message:
-----------
STS-391: Fixed some problems in the javadoc comments that were generating 
warnings.

Modified Paths:
--------------
    
branches/1.5.x/stripes/src/net/sourceforge/stripes/controller/DynamicMappingFilter.java
    
branches/1.5.x/stripes/src/net/sourceforge/stripes/tag/layout/LayoutComponentTag.java
    
branches/1.5.x/stripes/src/net/sourceforge/stripes/tag/layout/LayoutContext.java
    
branches/1.5.x/stripes/src/net/sourceforge/stripes/tag/layout/LayoutRenderTag.java

Modified: 
branches/1.5.x/stripes/src/net/sourceforge/stripes/controller/DynamicMappingFilter.java
===================================================================
--- 
branches/1.5.x/stripes/src/net/sourceforge/stripes/controller/DynamicMappingFilter.java
     2010-05-23 02:21:52 UTC (rev 1247)
+++ 
branches/1.5.x/stripes/src/net/sourceforge/stripes/controller/DynamicMappingFilter.java
     2010-05-24 14:32:09 UTC (rev 1248)
@@ -96,9 +96,9 @@
  * <p>
  * One benefit of this approach is that static resources can be delivered from 
the same namespace to
  * which an {...@link ActionBean} is mapped using clean URLs. (For more 
information on clean URLs, see
- * {...@link UrlBinding}.) For example, if your {...@code UserActionBean} is 
mapped to {...@code
- * @UrlBinding("/user/{id}/{$event}")} and you have a static file at {...@code 
/user/icon.gif}, then
- * your icon will be delivered correctly because the initial request will not 
have returned a
+ * {...@link UrlBinding}.) For example, if your {...@code UserActionBean} is 
mapped to
+ * {...@code @UrlBinding("/user/{id}/{$event}")} and you have a static file at 
{...@code /user/icon.gif},
+ * then your icon will be delivered correctly because the initial request will 
not have returned a
  * {...@code 404} error.
  * </p>
  * <p>
@@ -588,10 +588,10 @@
 
     /**
      * Get all the URL patterns to which a filter is mapped in {...@code 
web.xml}. This includes direct
-     * mappings using {...@code filter-mapping/url-pattern} and indirect 
mappings using {...@code
-     * filter-mapping/servlet-name} and {...@code servlet-mapping/url-pattern}.
+     * mappings using {...@code filter-mapping/url-pattern} and indirect 
mappings using
+     * {...@code filter-mapping/servlet-name} and {...@code 
servlet-mapping/url-pattern}.
      * 
-     * @param filterNode The DOM ({...@code &lt;filter&gt;) {...@link Node} 
containing the filter
+     * @param filterNode The DOM ({...@code &lt;filter&gt;)} {...@link Node} 
containing the filter
      *            declaration from {...@code web.xml}
      * @return A list of all the patterns to which the filter is mapped
      * @throws XPathExpressionException In case of failure evaluating an xpath 
expression
@@ -630,7 +630,7 @@
     /**
      * Get the initialization parameters for a filter declared in {...@code 
web.xml}.
      * 
-     * @param filterNode The DOM ({...@code &lt;filter&gt;) {...@link Node} 
containing the filter
+     * @param filterNode The DOM ({...@code &lt;filter&gt;)} {...@link Node} 
containing the filter
      *            declaration from {...@code web.xml}
      * @return A map of parameter names to parameter values
      * @throws XPathExpressionException In case of failure evaluation an xpath 
expression
@@ -672,7 +672,6 @@
      *            in {...@code web.xml}
      * @param request The current request, required to process a forward or 
include
      * @param response The current response, required to process a forward or 
include
-     * @return
      */
     protected void issueRequests(List<String> patterns, HttpServletRequest 
request,
             HttpServletResponse response) {
@@ -812,4 +811,4 @@
             }
         }
     }
-}
\ No newline at end of file
+}

Modified: 
branches/1.5.x/stripes/src/net/sourceforge/stripes/tag/layout/LayoutComponentTag.java
===================================================================
--- 
branches/1.5.x/stripes/src/net/sourceforge/stripes/tag/layout/LayoutComponentTag.java
       2010-05-23 02:21:52 UTC (rev 1247)
+++ 
branches/1.5.x/stripes/src/net/sourceforge/stripes/tag/layout/LayoutComponentTag.java
       2010-05-24 14:32:09 UTC (rev 1248)
@@ -89,8 +89,8 @@
      * </p>
      * <p>
      * If this tag is nested within a {...@link LayoutRenderTag} and this tag 
is the current component,
-     * as indicated by {...@link LayoutContext#getCurrentComponentName()}, 
then evaluate this tag's
-     * body by returning {...@code EVAL_BODY_INCLUDE}.
+     * as indicated by {...@link LayoutContext#getComponent()}, then evaluate 
this tag's body by
+     * returning {...@code EVAL_BODY_INCLUDE}.
      * </p>
      * <p>
      * In all other cases, skip this tag's body by returning SKIP_BODY.
@@ -182,8 +182,8 @@
 
     /**
      * If this tag is the component that needs to be rendered, as indicated by
-     * {...@link LayoutContext#getCurrentComponentName()}, then set the 
current component name back to
-     * null to indicate that the component has rendered.
+     * {...@link LayoutContext#getComponent()}, then set the current component 
name back to null to
+     * indicate that the component has rendered.
      * 
      * @return SKIP_PAGE if this component is the current component, otherwise 
EVAL_PAGE.
      */

Modified: 
branches/1.5.x/stripes/src/net/sourceforge/stripes/tag/layout/LayoutContext.java
===================================================================
--- 
branches/1.5.x/stripes/src/net/sourceforge/stripes/tag/layout/LayoutContext.java
    2010-05-23 02:21:52 UTC (rev 1247)
+++ 
branches/1.5.x/stripes/src/net/sourceforge/stripes/tag/layout/LayoutContext.java
    2010-05-24 14:32:09 UTC (rev 1248)
@@ -112,7 +112,7 @@
      * A new context may be created only by a {...@link LayoutRenderTag}. The 
tag provides all the
      * information necessary to initialize the context.
      * 
-     * @param tag The tag that is beginning a new layout render process.
+     * @param renderTag The tag that is beginning a new layout render process.
      */
     public LayoutContext(LayoutRenderTag renderTag) {
         this.renderTag = renderTag;

Modified: 
branches/1.5.x/stripes/src/net/sourceforge/stripes/tag/layout/LayoutRenderTag.java
===================================================================
--- 
branches/1.5.x/stripes/src/net/sourceforge/stripes/tag/layout/LayoutRenderTag.java
  2010-05-23 02:21:52 UTC (rev 1247)
+++ 
branches/1.5.x/stripes/src/net/sourceforge/stripes/tag/layout/LayoutRenderTag.java
  2010-05-24 14:32:09 UTC (rev 1248)
@@ -87,7 +87,7 @@
     }
 
     /**
-     * On the first pass (see {...@link #isRecursing()}):
+     * On the first pass (see {...@link 
LayoutContext#isComponentRenderPhase()}):
      * <ul>
      * <li>Push the values of any dynamic attributes into page context 
attributes for the duration
      * of the tag.</li>
@@ -119,7 +119,7 @@
     }
 
     /**
-     * After the first pass (see {...@link #isRecursing()}):
+     * After the first pass (see {...@link 
LayoutContext#isComponentRenderPhase()}):
      * <ul>
      * <li>Ensure the layout rendered successfully by checking {...@link 
LayoutContext#isRendered()}.</li>
      * <li>Remove the current layout context from request scope.</li>


This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.

------------------------------------------------------------------------------

_______________________________________________
Stripes-development mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/stripes-development

Reply via email to