Return-Path:
X-Original-To: apmail-commons-commits-archive@minotaur.apache.org
Delivered-To: apmail-commons-commits-archive@minotaur.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
by minotaur.apache.org (Postfix) with SMTP id 7A8CA18A44
for ;
Thu, 19 Nov 2015 21:29:15 +0000 (UTC)
Received: (qmail 41652 invoked by uid 500); 19 Nov 2015 21:29:15 -0000
Delivered-To: apmail-commons-commits-archive@commons.apache.org
Received: (qmail 41570 invoked by uid 500); 19 Nov 2015 21:29:15 -0000
Mailing-List: contact commits-help@commons.apache.org; run by ezmlm
Precedence: bulk
List-Help:
List-Unsubscribe:
List-Post:
List-Id:
Reply-To: dev@commons.apache.org
Delivered-To: mailing list commits@commons.apache.org
Received: (qmail 41560 invoked by uid 99); 19 Nov 2015 21:29:15 -0000
Received: from Unknown (HELO spamd3-us-west.apache.org) (209.188.14.142)
by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 19 Nov 2015 21:29:15 +0000
Received: from localhost (localhost [127.0.0.1])
by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org)
with ESMTP id BE222180AA8
for ; Thu, 19 Nov 2015 21:29:14 +0000 (UTC)
X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org
X-Spam-Flag: NO
X-Spam-Score: 1.79
X-Spam-Level: *
X-Spam-Status: No, score=1.79 tagged_above=-999 required=6.31
tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1,
T_RP_MATCHES_RCVD=-0.01] autolearn=disabled
Received: from mx1-eu-west.apache.org ([10.40.0.8])
by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new,
port 10024)
with ESMTP id 8CvuODw96B1D for ;
Thu, 19 Nov 2015 21:29:13 +0000 (UTC)
Received: from mailrelay1-us-west.apache.org (mailrelay1-us-west.apache.org
[209.188.14.139])
by mx1-eu-west.apache.org (ASF Mail Server at mx1-eu-west.apache.org) with
ESMTP id 57ED323047
for ; Thu, 19 Nov 2015 21:29:12 +0000 (UTC)
Received: from svn01-us-west.apache.org (svn.apache.org [10.41.0.6])
by mailrelay1-us-west.apache.org (ASF Mail Server at
mailrelay1-us-west.apache.org) with ESMTP id 9DAFCE00B6
for ; Thu, 19 Nov 2015 21:29:11 +0000 (UTC)
Received: from svn01-us-west.apache.org (localhost [127.0.0.1])
by svn01-us-west.apache.org (ASF Mail Server at svn01-us-west.apache.org)
with ESMTP id 9C6363A00E5
for ; Thu, 19 Nov 2015 21:29:11 +0000 (UTC)
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1715286 - in
/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2:
INIConfiguration.java PropertiesConfiguration.java XMLConfiguration.java
Date: Thu, 19 Nov 2015 21:29:11 -0000
To: commits@commons.apache.org
From: oheger@apache.org
X-Mailer: svnmailer-1.0.9
Message-Id: <20151119212911.9C6363A00E5@svn01-us-west.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.
*
+ *
+ * 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
+ *
+ * Basic features and AbstractConfiguration of the user's guide.
+ *
*
* @author 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.
+ * 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
+ *
+ * Basic features and AbstractConfiguration of the user's guide. There is
+ * also a separate chapter dealing with
+ *
+ * Properties files 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.
*
+ *
+ * More information about the basic functionality supported by
+ * {@code XMLConfiguration} can be found at the user's guide at
+ *
+ * Basic features and AbstractConfiguration. There is
+ * also a separate chapter dealing with
+ *
+ * XML Configurations in special.
+ *
*
* @since commons-configuration 1.0
* @author Jörg Schaible