Mailing-List: contact commits-help@commons.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@commons.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1158884 -
 /commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/HierarchicalReloadableConfiguration.java
Date: Wed, 17 Aug 2011 19:56:38 -0000
To: commits@commons.apache.org
From: oheger@apache.org
Message-Id: <20110817195639.0E06023889E5@eris.apache.org>

Author: oheger
Date: Wed Aug 17 19:56:38 2011
New Revision: 1158884

URL: http://svn.apache.org/viewvc?rev=1158884&view=rev
Log:
Javadoc improvements to make Checkstyle happy.

Modified:
    commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/HierarchicalReloadableConfiguration.java

Modified: commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/HierarchicalReloadableConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/HierarchicalReloadableConfiguration.java?rev=1158884&r1=1158883&r2=1158884&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/HierarchicalReloadableConfiguration.java (original)
+++ commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/HierarchicalReloadableConfiguration.java Wed Aug 17 19:56:38 2011
@@ -19,15 +19,24 @@ package org.apache.commons.configuration
 import org.apache.commons.configuration.reloading.Reloadable;
 
 /**
+ * <p>A base class for hierarchical configurations with specific reloading
+ * requirements.</p>
+ * <p>This class manages a lock object which can be used for synchronization.</p>
  *
+ * @author <a
+ *         href="http://commons.apache.org/configuration/team-list.html">Commons
+ *         Configuration team</a>
+ * @version $Id: $
  */
 public class HierarchicalReloadableConfiguration extends HierarchicalConfiguration
     implements Reloadable
 {
-    private final Object reloadLock;
-
+    /** Constant for the name used for the lock object. */
     private static final String LOCK_NAME = "HierarchicalReloadableConfigurationLock";
 
+    /** The lock object used by this instance. */
+    private final Object reloadLock;
+
     /**
      * Creates a new instance of <code>HierarchicalReloadableConfiguration</code>.
      */
@@ -37,6 +46,13 @@ public class HierarchicalReloadableConfi
         reloadLock = new Lock(LOCK_NAME);
     }
 
+    /**
+     * Creates a new instance of
+     * <code>HierarchicalReloadableConfiguration</code> and initializes it with
+     * the given lock object.
+     *
+     * @param lock the lock object
+     */
     public HierarchicalReloadableConfiguration(Object lock)
     {
         super();
@@ -50,7 +66,6 @@ public class HierarchicalReloadableConfi
      *
      * @param c the configuration that is to be copied (if <b>null</b>, this
      * constructor will behave like the standard constructor)
-     * @since 1.4
      */
     public HierarchicalReloadableConfiguration(HierarchicalConfiguration c)
     {
@@ -58,7 +73,6 @@ public class HierarchicalReloadableConfi
         reloadLock = new Lock(LOCK_NAME);
     }
 
-
     public Object getReloadLock()
     {
         return reloadLock;