You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@velocity.apache.org by nb...@apache.org on 2007/05/09 00:39:45 UTC
svn commit: r536364 - in /velocity/tools/trunk:
src/java/org/apache/velocity/tools/struts/StrutsLinkTool.java
xdocs/struts/StrutsLinkTool.xml
Author: nbubna
Date: Tue May 8 15:39:44 2007
New Revision: 536364
URL: http://svn.apache.org/viewvc?view=rev&rev=536364
Log:
doc updates for r536295 (VELTOOLS-82), thanks to Christopher Schultz
Modified:
velocity/tools/trunk/src/java/org/apache/velocity/tools/struts/StrutsLinkTool.java
velocity/tools/trunk/xdocs/struts/StrutsLinkTool.xml
Modified: velocity/tools/trunk/src/java/org/apache/velocity/tools/struts/StrutsLinkTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/src/java/org/apache/velocity/tools/struts/StrutsLinkTool.java?view=diff&rev=536364&r1=536363&r2=536364
==============================================================================
--- velocity/tools/trunk/src/java/org/apache/velocity/tools/struts/StrutsLinkTool.java (original)
+++ velocity/tools/trunk/src/java/org/apache/velocity/tools/struts/StrutsLinkTool.java Tue May 8 15:39:44 2007
@@ -111,13 +111,15 @@
/**
- * <p>Returns a copy of the link with the given global forward name
- * converted into a server-relative URI reference. If the parameter
+ * <p>Returns a copy of the link with the given global or local forward
+ * name converted into a server-relative URI reference. If the parameter
* does not map to an existing global forward name, <code>null</code>
* is returned. This method will overwrite any previous URI reference
* settings but will copy the query string.</p>
*
- * @param forward a global forward name as defined in struts-config.xml
+ * @param forward a forward name as defined in struts-config.xml
+ * in either global-forwards or in the currently executing
+ * action mapping.
*
* @return a new instance of StrutsLinkTool
*/
Modified: velocity/tools/trunk/xdocs/struts/StrutsLinkTool.xml
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/xdocs/struts/StrutsLinkTool.xml?view=diff&rev=536364&r1=536363&r2=536364
==============================================================================
--- velocity/tools/trunk/xdocs/struts/StrutsLinkTool.xml (original)
+++ velocity/tools/trunk/xdocs/struts/StrutsLinkTool.xml Tue May 8 15:39:44 2007
@@ -100,7 +100,8 @@
<method name="setForward()">
<abstract>
- Returns a copy of this StrutsLinkTool instance with the given global
+ Returns a copy of this StrutsLinkTool instance with the given
+ global or local
forward name converted into a server-relative URI reference.
</abstract>
@@ -110,7 +111,9 @@
<parameters>
<parameter name="forward">
- The name of a global forward as defined in struts-config.xml.
+ The name of a global or local forward as defined in
+ struts-config.xml. (global-forward section for global
+ or within an action mapping for local forwards).
</parameter>
</parameters>
@@ -120,7 +123,7 @@
</returns>
<description>
- <p>The global forward name is translated into a server-relative
+ <p>The forward URL is translated into a server-relative
URI reference. This method will overwrite any previously set URI
reference but will copy the query string.</p>
</description>