Link to examples and overview from Config, ConfigFactory docs

Trying to help people find the big-picture points they need to see.
This commit is contained in:
Havoc Pennington 2013-05-19 10:26:48 -04:00
parent 61675293f7
commit 4a62e10754
2 changed files with 12 additions and 0 deletions

View File

@ -66,6 +66,12 @@ import java.util.Set;
* can use {@link #entrySet()} which recurses the object tree for you and builds
* up a <code>Set</code> of all path-value pairs where the value is not null.
*
* <p> You can find an example app and library <a
* href="https://github.com/typesafehub/config/tree/master/examples">on
* GitHub</a>. Also be sure to read the package overview
* ({@link com.typesafe.config}) which describes the big picture as shown
* in those examples.
*
* <p>
* <em>Do not implement {@code Config}</em>; it should only be implemented by
* the config library. Arbitrary implementations will not work because the

View File

@ -27,6 +27,12 @@ import com.typesafe.config.impl.Parseable;
* operation potentially parsing multiple resources and resolving substitutions,
* while the ones with "parse" in the name just create a {@link ConfigValue}
* from a resource and nothing else.
*
* <p> You can find an example app and library <a
* href="https://github.com/typesafehub/config/tree/master/examples">on
* GitHub</a>. Also be sure to read the package overview
* ({@link com.typesafe.config}) which describes the big picture as shown
* in those examples.
*/
public final class ConfigFactory {
private ConfigFactory() {