summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsk89q <the.sk89q@gmail.com>2011-01-15 00:29:38 -0800
committersk89q <the.sk89q@gmail.com>2011-01-15 00:29:38 -0800
commitd8bf59f639e4c03becc98e5bc4da2f88dba471fa (patch)
tree0ee560310e8c8750def7de2577cae22849b3dc4a
parent79a3d54eef19323e94785a2cf5c4572db2997ac7 (diff)
downloadbukkit-d8bf59f639e4c03becc98e5bc4da2f88dba471fa.tar
bukkit-d8bf59f639e4c03becc98e5bc4da2f88dba471fa.tar.gz
bukkit-d8bf59f639e4c03becc98e5bc4da2f88dba471fa.tar.lz
bukkit-d8bf59f639e4c03becc98e5bc4da2f88dba471fa.tar.xz
bukkit-d8bf59f639e4c03becc98e5bc4da2f88dba471fa.zip
Improved the Javadoc for JavaPlugin.getConfiguration().
-rw-r--r--src/main/java/org/bukkit/plugin/java/JavaPlugin.java5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/main/java/org/bukkit/plugin/java/JavaPlugin.java b/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
index 2a70ecc7..629ec091 100644
--- 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
*/