svn commit: r1715517 - /tomcat/trunk/java/org/apache/catalina/session/StoreBase.java

[fs...@apache.org]

Author: fschumacher
Date: Sat Nov 21 13:11:23 2015
New Revision: 1715517

URL: http://svn.apache.org/viewvc?rev=1715517&view=rev
Log:
Javadoc changes. Markup changes and addition of return annotations.

Modified:
    tomcat/trunk/java/org/apache/catalina/session/StoreBase.java

Modified: tomcat/trunk/java/org/apache/catalina/session/StoreBase.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/session/StoreBase.java?rev=1715517&r1=1715516&r2=1715517&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/session/StoreBase.java (original)
+++ tomcat/trunk/java/org/apache/catalina/session/StoreBase.java Sat Nov 21 13:11:23 2015
@@ -29,8 +29,8 @@ import org.apache.catalina.util.Lifecycl
 import org.apache.tomcat.util.res.StringManager;
 
 /**
- * Abstract implementation of the Store interface to
- * support most of the functionality required by a Store.
+ * Abstract implementation of the {@link Store} interface to
+ * support most of the functionality required by a {@link Store}.
  *
  * @author Bip Thelin
  */
@@ -54,7 +54,7 @@ public abstract class StoreBase extends
     protected static final StringManager sm = StringManager.getManager(Constants.Package);
 
     /**
-     * The Manager with which this JDBCStore is associated.
+     * The Manager with which this Store is associated.
      */
     protected Manager manager;
 
@@ -62,7 +62,7 @@ public abstract class StoreBase extends
     // ------------------------------------------------------------- Properties
 
     /**
-     * Return the name for this Store, used for logging.
+     * @return the name for this Store, used for logging.
      */
     public String getStoreName() {
         return(storeName);
@@ -82,7 +82,7 @@ public abstract class StoreBase extends
     }
 
     /**
-     * Return the Manager with which the Store is associated.
+     * @return the Manager with which the Store is associated.
      */
     @Override
     public Manager getManager() {
@@ -95,7 +95,7 @@ public abstract class StoreBase extends
     /**
      * Add a property change listener to this component.
      *
-     * @param listener a value of type 'PropertyChangeListener'
+     * @param listener a value of type {@link PropertyChangeListener}
      */
     @Override
     public void addPropertyChangeListener(PropertyChangeListener listener) {
@@ -225,7 +225,7 @@ public abstract class StoreBase extends
 
 
     /**
-     * Return a String rendering of this object.
+     * @return a String rendering of this object.
      */
     @Override
     public String toString() {



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org