mention in Config.resolve docs that ConfigFactory methods may call it…

… for you
scala-steward · May 19, 2013 · bad495b · bad495b
1 parent 29c7d62
commit bad495b
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/config/src/main/java/com/typesafe/config/Config.java b/config/src/main/java/com/typesafe/config/Config.java
@@ -142,6 +142,16 @@ public interface Config extends ConfigMergeable {
      *   }
      * </pre>
      *
+     * <p>
+     * Many methods on {@link ConfigFactory} such as {@link
+     * ConfigFactory#load()} automatically resolve the loaded
+     * <code>Config</code> on the loaded stack of config files.
+     *
+     * <p> Resolving an already-resolved config is a harmless
+     * no-op, but again, it is best to resolve an entire stack of
+     * fallbacks (such as all your config files combined) rather
+     * than resolving each one individually.
+     *
      * @return an immutable object with substitutions resolved
      * @throws ConfigException.UnresolvedSubstitution
      *             if any substitutions refer to nonexistent paths