svn commit: r1715286 - in /commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2: INIConfiguration.java PropertiesConfiguration.java XMLConfiguration.java

[oh...@apache.org]

Author: oheger
Date: Thu Nov 19 21:29:11 2015
New Revision: 1715286

URL: http://svn.apache.org/viewvc?rev=1715286&view=rev
Log:
[CONFIGURATION-610] Javadoc improvements.

There are now links to the user's guide from some prominent configuration
classes.

Modified:
    commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
    commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
    commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/XMLConfiguration.java

Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/INIConfiguration.java?rev=1715286&r1=1715285&r2=1715286&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/INIConfiguration.java (original)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/INIConfiguration.java Thu Nov 19 21:29:11 2015
@@ -206,6 +206,13 @@ import org.apache.commons.configuration2
  * the {@code lock()} and {@code unlock()} methods manually to ensure that
  * other threads see your changes.
  * </p>
+ * <p>
+ * As this class extends {@link AbstractConfiguration}, all basic features
+ * like variable interpolation, list handling, or data type conversions are
+ * available as well. This is described in the chapter
+ * <a href="http://commons.apache.org/proper/commons-configuration/userguide/howto_basicfeatures.html">
+ * Basic features and AbstractConfiguration</a> of the user's guide.
+ * </p>
  *
  * @author <a
  *         href="http://commons.apache.org/configuration/team-list.html">Commons

Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java?rev=1715286&r1=1715285&r2=1715286&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java (original)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java Thu Nov 19 21:29:11 2015
@@ -181,6 +181,14 @@ import org.apache.commons.lang3.text.tra
  * change such properties during life time of an instance, you have to use
  * the {@code lock()} and {@code unlock()} methods manually to ensure that
  * other threads see your changes.
+ * <p>As this class extends {@link AbstractConfiguration}, all basic features
+ * like variable interpolation, list handling, or data type conversions are
+ * available as well. This is described in the chapter
+ * <a href="http://commons.apache.org/proper/commons-configuration/userguide/howto_basicfeatures.html">
+ * Basic features and AbstractConfiguration</a> of the user's guide. There is
+ * also a separate chapter dealing with
+ * <a href="commons.apache.org/proper/commons-configuration/userguide/howto_properties.html">
+ * Properties files</a> in special.
  *
  * @see java.util.Properties#load
  *

Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/XMLConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/XMLConfiguration.java?rev=1715286&r1=1715285&r2=1715286&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/XMLConfiguration.java (original)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/XMLConfiguration.java Thu Nov 19 21:29:11 2015
@@ -176,6 +176,15 @@ import org.xml.sax.helpers.DefaultHandle
  * {@code lock()} and {@code unlock()} methods manually to ensure that other
  * threads see your changes.
  * </p>
+ * <p>
+ * More information about the basic functionality supported by
+ * {@code XMLConfiguration} can be found at the user's guide at
+ * <a href="http://commons.apache.org/proper/commons-configuration/userguide/howto_basicfeatures.html">
+ * Basic features and AbstractConfiguration</a>. There is
+ * also a separate chapter dealing with
+ * <a href="commons.apache.org/proper/commons-configuration/userguide/howto_xml.html">
+ * XML Configurations</a> in special.
+ * </p>
  *
  * @since commons-configuration 1.0
  * @author J&ouml;rg Schaible