Upstream/Multiverse-Core
1
0
Fork 0
mirror of https://github.com/Multiverse/Multiverse-Core.git synced 2024-11-25 03:55:27 +01:00
Code Issues Projects Releases Wiki Activity

Added some javadocs.

Browse Source
This commit is contained in:
Jeremy Wood 2012-11-28 19:14:41 -05:00
parent 32c92fc39d
commit 1708d1dedd
4 changed files with 26 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
base/src/main/java/com/mvplugin/core/api/MultiverseCore.java
View File

@ -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();
}

12
base/src/main/java/com/mvplugin/core/api/MultiversePlugin.java
View File

@ -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();
}

5
base/src/main/java/com/mvplugin/core/api/package-info.java Normal file
View File

@ -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;

7
bukkit/src/main/java/com/mvplugin/core/MultiverseCorePlugin.java
View File

@ -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