svn commit: r1819882 - /commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java

[oh...@apache.org]

Author: oheger
Date: Tue Jan  2 19:59:19 2018
New Revision: 1819882

URL: http://svn.apache.org/viewvc?rev=1819882&view=rev
Log:
CONFIGURATION-684: Javadoc improvements.

Added a note that keys returned by getKeys() may have been manipulated
to escape special characters.

Modified:
    commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java

Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java?rev=1819882&r1=1819881&r2=1819882&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java (original)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java Tue Jan  2 19:59:19 2018
@@ -120,7 +120,9 @@ public interface ImmutableConfiguration
      * Get the list of the keys contained in the configuration. The returned
      * iterator can be used to obtain all defined keys. It does not allow
      * removing elements from this configuration via its {@code remove()}
-     * method.
+     * method. Note that the keys of this configuration are returned in a form,
+     * so that they can be directly evaluated; escaping of special characters
+     * (if necessary) has already been performed.
      *
      * @return An Iterator.
      */