Author: husted
Date: Fri Oct 29 08:34:55 2004
New Revision: 55980
Modified:
struts/trunk/src/share/org/apache/struts/config/ForwardConfig.java
struts/trunk/src/share/org/apache/struts/taglib/html/LinkTag.java
Log:
Document that if a link to a forward is used to switch modules, the path must point to
an action.
Modified: struts/trunk/src/share/org/apache/struts/config/ForwardConfig.java
==============================================================================
--- struts/trunk/src/share/org/apache/struts/config/ForwardConfig.java (original)
+++ struts/trunk/src/share/org/apache/struts/config/ForwardConfig.java Fri Oct 29
08:34:55 2004
@@ -86,8 +86,7 @@
}
/**
- * Construct a new instance with the specified values.
- *
+ * <p>Construct a new instance with the specified values.</p>
* @param name Name of this forward
* @param path Path to which control should be forwarded or redirected
* @param redirect Should we do a redirect?
@@ -198,6 +197,12 @@
/**
* <p>The prefix of the module to which this <code>ForwardConfig</code> entry
points,
* which must start with a slash ("/") character. </p>
+ * <p>Usage note: If a forward config is used in a hyperlink,
+ * and a module is specified, the path must lead to another
+ * action and not directly to a page. This is in keeping with
+ * rule that in a modular application all links must be to
+ * an action rather than a page.
+ * </p>
*/
protected String module = null;
Modified: struts/trunk/src/share/org/apache/struts/taglib/html/LinkTag.java
==============================================================================
--- struts/trunk/src/share/org/apache/struts/taglib/html/LinkTag.java (original)
+++ struts/trunk/src/share/org/apache/struts/taglib/html/LinkTag.java Fri Oct 29
08:34:55 2004
@@ -63,7 +63,13 @@
/**
- * The logical forward name from which to retrieve the hyperlink URI.
+ * <p>The logical forward name from which to retrieve the hyperlink URI.</p>
+ * <p>Usage note: If a forward config is used in a hyperlink,
+ * and a module is specified, the path must lead to another
+ * action and not directly to a page. This is in keeping with
+ * rule that in a modular application all links must be to
+ * an action rather than a page.
+ * </p>
*/
protected String forward = null;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
