diff --git a/base/src/main/java/com/mvplugin/core/api/MultiverseCore.java b/base/src/main/java/com/mvplugin/core/api/MultiverseCore.java index b9e4b596..36b33c92 100644 --- a/base/src/main/java/com/mvplugin/core/api/MultiverseCore.java +++ b/base/src/main/java/com/mvplugin/core/api/MultiverseCore.java @@ -9,14 +9,20 @@ import com.dumptruckman.minecraft.pluginbase.plugin.PluginBase; * This is the class you should cast your plugin to unless you need more Implementation specific API. */ public interface MultiverseCore extends MultiversePlugin, PluginBase { + /** - * Gets the primary class responsible for managing Multiverse Worlds. + * Gets the Multiverse world manager. + * + * The world manager allows you to perform various tasks related to Minecraft worlds. * * @return {@link WorldManager}. */ WorldManager getWorldManager(); - CoreConfig config(); - + /** + * Gets the Multiverse-Core configuration. + * + * @return The Multiverse-Core configuration. + */ CoreConfig getMVConfig(); } diff --git a/base/src/main/java/com/mvplugin/core/api/MultiversePlugin.java b/base/src/main/java/com/mvplugin/core/api/MultiversePlugin.java index 7d188ccf..150e9d56 100644 --- a/base/src/main/java/com/mvplugin/core/api/MultiversePlugin.java +++ b/base/src/main/java/com/mvplugin/core/api/MultiversePlugin.java @@ -1,5 +1,8 @@ package com.mvplugin.core.api; +/** + * Implement this if you would + */ public interface MultiversePlugin { /** @@ -17,11 +20,12 @@ public interface MultiversePlugin { void setCore(MultiverseCore core); /** - * Allows Multiverse or a plugin to query another Multiverse plugin to see what version its protocol is. This - * number - * should change when something will break the code. + * Allows Multiverse or a plugin to query another Multiverse plugin to see what version its protocol is. * - * @return The Integer protocol version. + * This number should change when something will break the code. Generally your plugin should be checking the + * Multiverse-Core's protocol version to ensure compatibility. + * + * @return The protocol version. */ int getProtocolVersion(); } diff --git a/base/src/main/java/com/mvplugin/core/api/package-info.java b/base/src/main/java/com/mvplugin/core/api/package-info.java new file mode 100644 index 00000000..6f7c5720 --- /dev/null +++ b/base/src/main/java/com/mvplugin/core/api/package-info.java @@ -0,0 +1,5 @@ +/** + * The Multiverse-API, containing lots of interfaces that can be quite useful for other + * plugins when interacting with Multiverse. + */ +package com.mvplugin.core.api; diff --git a/bukkit/src/main/java/com/mvplugin/core/MultiverseCorePlugin.java b/bukkit/src/main/java/com/mvplugin/core/MultiverseCorePlugin.java index c3959d80..fe443a43 100644 --- a/bukkit/src/main/java/com/mvplugin/core/MultiverseCorePlugin.java +++ b/bukkit/src/main/java/com/mvplugin/core/MultiverseCorePlugin.java @@ -10,8 +10,9 @@ import com.mvplugin.core.util.PropertyDescriptions; import java.io.IOException; /** - * The primary Bukkit plugin implementation of Multiverse-Core. See {@link MultiverseCore} for a more detailed - * external api javadocs. + * The primary Bukkit plugin implementation of Multiverse-Core. + * + * See {@link MultiverseCore} for a more detailed external api javadocs. */ public class MultiverseCorePlugin extends AbstractBukkitPlugin implements MultiverseCore { @@ -56,7 +57,7 @@ public class MultiverseCorePlugin extends AbstractBukkitPlugin implements Multiv @Override public CoreConfig config() { - return (CoreConfig) super.config(); //To change body of overridden methods use File | Settings | File Templates. + return (CoreConfig) super.config(); } @Override