quintonm 2003/03/25 09:15:31
Modified: src/java/org/apache/turbine/util RelativeDynamicURI.java
SecurityCheck.java
src/java/org/apache/turbine/util/template
RelativeTemplateLink.java SelectorBox.java
TemplateLink.java TemplatePageAttributes.java
TemplateSecurityCheck.java
src/java/org/apache/turbine/util/upload MultipartStream.java
src/java/org/apache/turbine/util/velocity
VelocityActionEvent.java VelocityEmail.java
Log:
Javadoc updates
Scarab Issue: TRQD18
Patch supplied by Angelo Turetta [EMAIL PROTECTED]
Revision Changes Path
1.6 +1 -1
jakarta-turbine-2/src/java/org/apache/turbine/util/RelativeDynamicURI.java
Index: RelativeDynamicURI.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/RelativeDynamicURI.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- RelativeDynamicURI.java 19 Mar 2003 09:20:12 -0000 1.5
+++ RelativeDynamicURI.java 25 Mar 2003 17:15:30 -0000 1.6
@@ -74,7 +74,7 @@
*
* The above call to getA() would return the String:
*
- *
<AHREF="/servlets/Turbine/screen=UserScreen&amp;user=jon">ClickHere</A>
+ * <A
HREF="/servlets/Turbine/screen=UserScreen&amp;user=jon">ClickHere</A>
*
* @author <a href="mailto:[EMAIL PROTECTED]">David S. Faller</a>
*/
1.5 +3 -3
jakarta-turbine-2/src/java/org/apache/turbine/util/SecurityCheck.java
Index: SecurityCheck.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/SecurityCheck.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- SecurityCheck.java 9 Mar 2003 02:54:11 -0000 1.4
+++ SecurityCheck.java 25 Mar 2003 17:15:30 -0000 1.5
@@ -63,12 +63,12 @@
*
* Sample usage:<br>
*
- * <code>
+ * <pre><code>
* SecurityCheck mycheck =
* new SecurityCheck(data, "Unauthorized to do this!", "WrongPermission");
* if (!mycheck.hasPermission("add_user");
* return;
- *</code>
+ *</code></pre>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Dave Bryson</a>
* @version $Id$
1.6 +2 -2
jakarta-turbine-2/src/java/org/apache/turbine/util/template/RelativeTemplateLink.java
Index: RelativeTemplateLink.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/template/RelativeTemplateLink.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- RelativeTemplateLink.java 9 Mar 2003 06:01:07 -0000 1.5
+++ RelativeTemplateLink.java 25 Mar 2003 17:15:30 -0000 1.6
@@ -64,7 +64,7 @@
*
* <p><code>
* $link.setPage("index.wm").addPathInfo("hello","world")
- * This would return: /myapp/servlet/myapp/template/index.wm/hello/world
+ * </code><br />This would return:
<code>/myapp/servlet/myapp/template/index.wm/hello/world
* </code>
*
* @author <a href="[EMAIL PROTECTED]">John D. McNally</a>
1.5 +2 -2
jakarta-turbine-2/src/java/org/apache/turbine/util/template/SelectorBox.java
Index: SelectorBox.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/template/SelectorBox.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- SelectorBox.java 9 Mar 2003 02:54:14 -0000 1.4
+++ SelectorBox.java 25 Mar 2003 17:15:30 -0000 1.5
@@ -81,7 +81,7 @@
*
* Object[] names = new Object[allRoles.length];
* Object[] values = new Object[allRoles.length];
- * for ( int i=0;i<allRoles.length; i++ )
+ * for ( int i=0;i<allRoles.length; i++ )
* {
* names[i] = new Integer(allRoles[i].getPrimaryKey()).toString();
* values[i] = allRoles[i].getName();
1.6 +2 -2
jakarta-turbine-2/src/java/org/apache/turbine/util/template/TemplateLink.java
Index: TemplateLink.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/template/TemplateLink.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- TemplateLink.java 9 Mar 2003 05:57:08 -0000 1.5
+++ TemplateLink.java 25 Mar 2003 17:15:30 -0000 1.6
@@ -67,7 +67,7 @@
*
* <p><code>
* $link.setPage("index.wm").addPathInfo("hello","world")
- * This would return: http://foo.com/Turbine/template/index.wm/hello/world
+ * </code><br />This would return:
<code>http://foo.com/Turbine/template/index.wm/hello/world
* </code>
*
* @author <a href="[EMAIL PROTECTED]">Dave Bryson</a>
1.8 +3 -2
jakarta-turbine-2/src/java/org/apache/turbine/util/template/TemplatePageAttributes.java
Index: TemplatePageAttributes.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/template/TemplatePageAttributes.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- TemplatePageAttributes.java 9 Mar 2003 02:54:14 -0000 1.7
+++ TemplatePageAttributes.java 25 Mar 2003 17:15:30 -0000 1.8
@@ -70,13 +70,14 @@
* page. It is automatically placed in the Template context as
* '$page'. Here's an example of some uses:
*
- * <p>
+ * <p><pre><code>
* $page.setBgColor("#ffffff");
* $page.setBgColor("white");
* $page.setBackground("/images/standardbg.jpeg");
* $page.setTitle("This is the title!");
* $page.setKeywords("turbine, cool, servlet framework");
* $page.setStyleSheet("/style.css");
+ * </code></pre></p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Sean Legassick</a>
* @deprecated Use HtmlPageAttributes along with VelocityOnlyLayout instead
1.6 +3 -3
jakarta-turbine-2/src/java/org/apache/turbine/util/template/TemplateSecurityCheck.java
Index: TemplateSecurityCheck.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/template/TemplateSecurityCheck.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- TemplateSecurityCheck.java 9 Mar 2003 02:54:14 -0000 1.5
+++ TemplateSecurityCheck.java 25 Mar 2003 17:15:30 -0000 1.6
@@ -70,14 +70,14 @@
* Utility class to help check for proper authorization when using
* template screens. Sample usages:
*
- * <p><code>
+ * <p><pre><code>
* TemplateSecurityCheck secCheck = new TemplateSecurityCheck( data );
* secCheck.setMessage( "Sorry, you do not have permission to " +
* "access this area." );
* secCheck.setFailTemplate("login.wm");
* if ( !secCheck.hasRole("ADMIN") )
* return;
- * </code>
+ * </pre></code>
*
* @author <a href="[EMAIL PROTECTED]">Dave Bryson</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Henning P. Schmiedehausen</a>
1.5 +1 -2
jakarta-turbine-2/src/java/org/apache/turbine/util/upload/MultipartStream.java
Index: MultipartStream.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/upload/MultipartStream.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- MultipartStream.java 9 Mar 2003 02:54:14 -0000 1.4
+++ MultipartStream.java 25 Mar 2003 17:15:30 -0000 1.5
@@ -108,7 +108,6 @@
* } catch(IOException) {
* // a read or write error occurred
* }
- *
* </pre>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Rafal Krzewski</a>
1.8 +3 -3
jakarta-turbine-2/src/java/org/apache/turbine/util/velocity/VelocityActionEvent.java
Index: VelocityActionEvent.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/velocity/VelocityActionEvent.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- VelocityActionEvent.java 19 Mar 2003 16:12:06 -0000 1.7
+++ VelocityActionEvent.java 25 Mar 2003 17:15:31 -0000 1.8
@@ -72,11 +72,11 @@
* this class will first attempt to execute one of your doMethod's
* with a constructor like this:
*
- * <p>doEvent(RunData data, Context context)
+ * <p><code>doEvent(RunData data, Context context)</code></p>
*
* <p>It gets the context from the TemplateInfo.getTemplateContext()
* method. If it can't find a method like that, then it will try to
- * execute the method without the Context in it.
+ * execute the method without the Context in it.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Jon S. Stevens</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Jason van Zyl</a>
1.11 +2 -2
jakarta-turbine-2/src/java/org/apache/turbine/util/velocity/VelocityEmail.java
Index: VelocityEmail.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/util/velocity/VelocityEmail.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- VelocityEmail.java 19 Mar 2003 16:12:06 -0000 1.10
+++ VelocityEmail.java 25 Mar 2003 17:15:31 -0000 1.11
@@ -83,7 +83,7 @@
*
* <p>Setup your context:
*
- * <p>context.put ("VelocityEmail", new VelocityEmail() );
+ * <p><code>context.put ("VelocityEmail", new VelocityEmail() );</code>
*
* <p>Then, in your template:
*
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
