Improved the Javadoc for JavaPlugin.getConfiguration().

2011-01-15 00:29:38 -08:00
parent f8dba7655b
commit c944fa35af
1 changed files with 4 additions and 1 deletions
--- a/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
+++ b/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
@@ -96,7 +96,10 @@ public abstract class JavaPlugin implements Plugin {
    }
    
    /**
-     * Returns the main configuration file. It will be loaded.
+     * Returns the main configuration located at
+     * <plugin name>/config.yml and loads the file. If the configuration file
+     * does not exist and it cannot be loaded, no error will be emitted and
+     * the configuration file will have no values.
     * 
     * @return
     */