quintonm 2003/03/25 09:13:13
Modified: src/java/org/apache/turbine/services TurbineBaseService.java
src/java/org/apache/turbine/services/cache
TurbineGlobalCacheService.java
src/java/org/apache/turbine/services/pull
TurbinePullService.java
src/java/org/apache/turbine/services/session
SessionListener.java TurbineSessionService.java
Log:
Javadocs updates
Scarab Issue: TRQD18
Patch supplied by Angelo Turetta [EMAIL PROTECTED]
Revision Changes Path
1.6 +11 -11
jakarta-turbine-2/src/java/org/apache/turbine/services/TurbineBaseService.java
Index: TurbineBaseService.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/services/TurbineBaseService.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- TurbineBaseService.java 9 Mar 2003 07:16:45 -0000 1.5
+++ TurbineBaseService.java 25 Mar 2003 17:13:12 -0000 1.6
@@ -59,27 +59,27 @@
import org.apache.turbine.util.RunData;
/**
- * This class provides a <code>Service</code> implementation that
+ * <p>This class provides a <code>Service</code> implementation that
* Services used in Turbine are required to extend. The
* functionality provided in addition to <code>BaseService</code>
* functionality is recognizing objects used in early initialization
* of <code>Services</code> in Turbine, and passing them to
* appropriate convenience methods. These methods should be overriden
- * to provide desired initialization functionality.
+ * to provide desired initialization functionality.</p>
*
- * <strong>Note!</strong><br>Remember to call
- * <code>setInit(true)</code> after successful initialization.
+ * <p><strong>Note!</strong><br>Remember to call
+ * <code>setInit(true)</code> after successful initialization.</p>
*
- * <strong>Note!</strong><br>If you need to use another
+ * <p><strong>Note!</strong><br>If you need to use another
* <code>Service</code> inside your early initialization, remember to
* request initialization of that <code>Service</code> before using
- * it:
+ * it:</p>
*
- * <code>
- * getServiceBroker().initClass("OtherService",data);<br>
+ * <pre><code>
+ * getServiceBroker().initClass("OtherService",data);
* OtherService service =
- * (OtherService)getServiceBroker().getService("OtherService");
- * </code>
+ * (OtherService)getServiceBroker().getService("OtherService");
+ * </code></pre>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Greg Ritter</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Brett McLaughlin</a>
1.7 +2 -2
jakarta-turbine-2/src/java/org/apache/turbine/services/cache/TurbineGlobalCacheService.java
Index: TurbineGlobalCacheService.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/services/cache/TurbineGlobalCacheService.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- TurbineGlobalCacheService.java 9 Mar 2003 03:06:25 -0000 1.6
+++ TurbineGlobalCacheService.java 25 Mar 2003 17:13:12 -0000 1.7
@@ -86,7 +86,7 @@
*
* <dl>
* <dt>classname</dt><dd>the classname of this service</dd>
- * <dt>cache.initial.size/dt><dd>Initial size of hash table use to store cached
+ * <dt>cache.initial.size</dt><dd>Initial size of hash table use to store cached
objects. If this property is not present, the default value is 20</dd>
* <dt>cache.check.frequency</dt><dd>Cache check frequency in Millis (1000
Millis = 1 second). If this property is not present, the default value is
5000</dd>
1.25 +5 -5
jakarta-turbine-2/src/java/org/apache/turbine/services/pull/TurbinePullService.java
Index: TurbinePullService.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/services/pull/TurbinePullService.java,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -r1.24 -r1.25
--- TurbinePullService.java 21 Mar 2003 22:44:54 -0000 1.24
+++ TurbinePullService.java 25 Mar 2003 17:13:13 -0000 1.25
@@ -84,14 +84,14 @@
* templates. You list the tools in the following way:
* <p>
* <pre>
- * tool.<scope>.<id> = <classname>
+ * tool.<scope>.<id> = <classname>
*
- * <scope> is the tool scope: global, request, session,
+ * <scope> is the tool scope: global, request, session,
* authorized or persistent (see below for more details)
- * <id> is the name of the tool in the context
+ * <id> is the name of the tool in the context
*
* You can configure the tools in this way:
- * tool.<id>.<parameter> = <value>
+ * tool.<id>.<parameter> = <value>
*
* So if you find "global", "request", "session" or "persistent" as second
* part, it is a configuration to put a tool into the toolbox, else it is a
1.9 +5 -5
jakarta-turbine-2/src/java/org/apache/turbine/services/session/SessionListener.java
Index: SessionListener.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/services/session/SessionListener.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- SessionListener.java 9 Mar 2003 03:06:33 -0000 1.8
+++ SessionListener.java 25 Mar 2003 17:13:13 -0000 1.9
@@ -66,11 +66,11 @@
* descriptor as follows for the container to call it:
*
* <blockquote><code><pre>
- * <listener>
- * <listener-class>
+ * <listener>
+ * <listener-class>
* org.apache.turbine.session.SessionListener
- * </listener-class>
- * </listener>
+ * </listener-class>
+ * </listener>
* </pre></code></blockquote>
*
* <code><listener></code> elemements can occur between
1.8 +5 -5
jakarta-turbine-2/src/java/org/apache/turbine/services/session/TurbineSessionService.java
Index: TurbineSessionService.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-2/src/java/org/apache/turbine/services/session/TurbineSessionService.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- TurbineSessionService.java 9 Mar 2003 03:06:33 -0000 1.7
+++ TurbineSessionService.java 25 Mar 2003 17:13:13 -0000 1.8
@@ -72,11 +72,11 @@
* deployement descriptor as follows:
*
* <blockquote><code><pre>
- * <listener>
- * <listener-class>
+ * <listener>
+ * <listener-class>
* org.apache.turbine.session.SessionListener
- * </listener-class>
- * </listener>
+ * </listener-class>
+ * </listener>
* </pre></code></blockquote>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Quinton McCombs</a>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
