Javadoc fixes

This commit is contained in:
Morgan 2011-06-29 19:11:03 -04:00
parent f841feb128
commit ccdc903007
11 changed files with 65 additions and 24 deletions

1
.gitignore vendored
View File

@ -6,4 +6,5 @@
.project .project
*/**/.settings */**/.settings
.settings .settings
javadoc
Vault.jar Vault.jar

View File

@ -5,7 +5,7 @@
<fileset dir="lib" includes="**/*.jar"/> <fileset dir="lib" includes="**/*.jar"/>
</path> </path>
<target name="main" depends="clean, compile, compress" description="Main target"> <target name="main" depends="clean, compile, compress, javadoc" description="Main target">
<echo>Building the .jar file.</echo> <echo>Building the .jar file.</echo>
</target> </target>
@ -13,6 +13,7 @@
<echo>Cleaning</echo> <echo>Cleaning</echo>
<delete failonerror="false"> <delete failonerror="false">
<fileset dir="bin" includes="**/*" /> <fileset dir="bin" includes="**/*" />
<fileset dir="javadoc" includes="**/*" />
</delete> </delete>
<delete file="Vault.jar" /> <delete file="Vault.jar" />
<mkdir dir="bin"/> <mkdir dir="bin"/>
@ -33,4 +34,20 @@
</jar> </jar>
<delete dir="bin" /> <delete dir="bin" />
</target> </target>
<target name="javadoc" description="Generate JavaDoc">
<javadoc packagenames="net.milkbowl.vault.economy,net.milkbowl.vault.permission"
sourcepath="src"
destdir="javadoc"
access="public"
windowtitle="Vault"
verbose="false"
author="true"
version="true">
<bottom>
<![CDATA[<b>MilkBukkit, 2011</b>]]>
</bottom>
</javadoc>
</target>
</project> </project>

View File

@ -22,9 +22,6 @@ package net.milkbowl.vault.economy;
import java.util.logging.Logger; import java.util.logging.Logger;
public interface Economy { public interface Economy {
public static final Logger log = Logger.getLogger("Minecraft");
public boolean isEnabled(); public boolean isEnabled();
public String getName(); public String getName();
public String format(double amount); public String format(double amount);

View File

@ -19,6 +19,8 @@
package net.milkbowl.vault.economy.plugins; package net.milkbowl.vault.economy.plugins;
import java.util.logging.Logger;
import me.ic3d.eco.ECO; import me.ic3d.eco.ECO;
import net.milkbowl.vault.economy.Economy; import net.milkbowl.vault.economy.Economy;
import net.milkbowl.vault.economy.EconomyResponse; import net.milkbowl.vault.economy.EconomyResponse;
@ -32,6 +34,8 @@ import org.bukkit.plugin.Plugin;
import org.bukkit.plugin.PluginManager; import org.bukkit.plugin.PluginManager;
public class Economy_3co implements Economy { public class Economy_3co implements Economy {
private static final Logger log = Logger.getLogger("Minecraft");
private String name = "3co"; private String name = "3co";
private Plugin plugin = null; private Plugin plugin = null;
private PluginManager pluginManager = null; private PluginManager pluginManager = null;

View File

@ -19,6 +19,8 @@
package net.milkbowl.vault.economy.plugins; package net.milkbowl.vault.economy.plugins;
import java.util.logging.Logger;
import net.milkbowl.vault.economy.Economy; import net.milkbowl.vault.economy.Economy;
import net.milkbowl.vault.economy.EconomyResponse; import net.milkbowl.vault.economy.EconomyResponse;
@ -34,6 +36,8 @@ import org.bukkit.plugin.PluginManager;
import cosine.boseconomy.BOSEconomy; import cosine.boseconomy.BOSEconomy;
public class Economy_BOSE implements Economy { public class Economy_BOSE implements Economy {
private static final Logger log = Logger.getLogger("Minecraft");
private String name = "BOSEconomy"; private String name = "BOSEconomy";
private Plugin plugin = null; private Plugin plugin = null;
private PluginManager pluginManager = null; private PluginManager pluginManager = null;

View File

@ -19,6 +19,8 @@
package net.milkbowl.vault.economy.plugins; package net.milkbowl.vault.economy.plugins;
import java.util.logging.Logger;
import net.milkbowl.vault.economy.Economy; import net.milkbowl.vault.economy.Economy;
import net.milkbowl.vault.economy.EconomyResponse; import net.milkbowl.vault.economy.EconomyResponse;
@ -35,6 +37,8 @@ import com.earth2me.essentials.api.NoLoanPermittedException;
import com.earth2me.essentials.api.UserDoesNotExistException; import com.earth2me.essentials.api.UserDoesNotExistException;
public class Economy_Essentials implements Economy { public class Economy_Essentials implements Economy {
private static final Logger log = Logger.getLogger("Minecraft");
private String name = "Essentials Economy"; private String name = "Essentials Economy";
private Plugin plugin = null; private Plugin plugin = null;
private PluginManager pluginManager = null; private PluginManager pluginManager = null;

View File

@ -19,6 +19,8 @@
package net.milkbowl.vault.economy.plugins; package net.milkbowl.vault.economy.plugins;
import java.util.logging.Logger;
import net.milkbowl.vault.economy.Economy; import net.milkbowl.vault.economy.Economy;
import net.milkbowl.vault.economy.EconomyResponse; import net.milkbowl.vault.economy.EconomyResponse;
@ -34,6 +36,8 @@ import com.nijiko.coelho.iConomy.iConomy;
import com.nijiko.coelho.iConomy.system.Account; import com.nijiko.coelho.iConomy.system.Account;
public class Economy_iConomy4 implements Economy { public class Economy_iConomy4 implements Economy {
private static final Logger log = Logger.getLogger("Minecraft");
private String name = "iConomy 4"; private String name = "iConomy 4";
private Plugin plugin = null; private Plugin plugin = null;
private PluginManager pluginManager = null; private PluginManager pluginManager = null;

View File

@ -19,6 +19,8 @@
package net.milkbowl.vault.economy.plugins; package net.milkbowl.vault.economy.plugins;
import java.util.logging.Logger;
import net.milkbowl.vault.economy.Economy; import net.milkbowl.vault.economy.Economy;
import net.milkbowl.vault.economy.EconomyResponse; import net.milkbowl.vault.economy.EconomyResponse;
@ -36,6 +38,8 @@ import com.iConomy.system.Account;
import com.iConomy.system.Holdings; import com.iConomy.system.Holdings;
public class Economy_iConomy5 implements Economy { public class Economy_iConomy5 implements Economy {
private static final Logger log = Logger.getLogger("Minecraft");
private String name = "iConomy 5"; private String name = "iConomy 5";
private JavaPlugin plugin = null; private JavaPlugin plugin = null;
private PluginManager pluginManager = null; private PluginManager pluginManager = null;

View File

@ -25,8 +25,6 @@ import org.bukkit.entity.Player;
public interface Permission { public interface Permission {
public static final Logger log = Logger.getLogger("Minecraft");
/** /**
* Gets name of permission method * Gets name of permission method
* @return Name of Permission Method * @return Name of Permission Method
@ -35,7 +33,7 @@ public interface Permission {
/** /**
* Checks if permission method is enabled. * Checks if permission method is enabled.
* @return * @return Success or Failure
*/ */
public boolean isEnabled(); public boolean isEnabled();
@ -43,7 +41,7 @@ public interface Permission {
* Checks if player has a permission node. * Checks if player has a permission node.
* @param player Player instance * @param player Player instance
* @param permission Permission node * @param permission Permission node
* @return * @return Success or Failure
*/ */
public boolean playerHasPermission(Player player, String permission); public boolean playerHasPermission(Player player, String permission);
@ -52,7 +50,7 @@ public interface Permission {
* @param worldName Name of World * @param worldName Name of World
* @param playerName Name of Player * @param playerName Name of Player
* @param permission Permission node * @param permission Permission node
* @return * @return Success or Failure
*/ */
public boolean playerAddPermission(String worldName, String playerName, String permission); public boolean playerAddPermission(String worldName, String playerName, String permission);
@ -61,7 +59,7 @@ public interface Permission {
* @param worldName Name of World * @param worldName Name of World
* @param playerName Name of Player * @param playerName Name of Player
* @param permission Permission node * @param permission Permission node
* @return * @return Success or Failure
*/ */
public boolean playerRemovePermission(String worldName, String playerName, String permission); public boolean playerRemovePermission(String worldName, String playerName, String permission);
@ -70,7 +68,7 @@ public interface Permission {
* @param worldName Name of World * @param worldName Name of World
* @param groupName Name of Group * @param groupName Name of Group
* @param permission Permission node * @param permission Permission node
* @return * @return Success or Failure
*/ */
public boolean groupHasPermission(String worldName, String groupName, String permission); public boolean groupHasPermission(String worldName, String groupName, String permission);
@ -79,7 +77,7 @@ public interface Permission {
* @param worldName Name of World * @param worldName Name of World
* @param groupName Name of Group * @param groupName Name of Group
* @param permission Permission node * @param permission Permission node
* @return * @return Success or Failure
*/ */
public boolean groupAddPermission(String worldName, String groupName, String permission); public boolean groupAddPermission(String worldName, String groupName, String permission);
@ -88,7 +86,7 @@ public interface Permission {
* @param worldName Name of World * @param worldName Name of World
* @param groupName Name of Group * @param groupName Name of Group
* @param permission Permission node * @param permission Permission node
* @return * @return Success or Failure
*/ */
public boolean groupRemovePermission(String worldName, String groupName, String permission); public boolean groupRemovePermission(String worldName, String groupName, String permission);
@ -97,7 +95,7 @@ public interface Permission {
* @param worldName Name of World * @param worldName Name of World
* @param playerName Name of Player * @param playerName Name of Player
* @param groupName Name of Group * @param groupName Name of Group
* @return * @return Success or Failure
*/ */
public boolean playerInGroup(String worldName, String playerName, String groupName); public boolean playerInGroup(String worldName, String playerName, String groupName);
@ -106,7 +104,7 @@ public interface Permission {
* @param worldName Name of World * @param worldName Name of World
* @param playerName Name of Player * @param playerName Name of Player
* @param groupName Name of Group * @param groupName Name of Group
* @return * @return Success or Failure
*/ */
public boolean playerAddGroup(String worldName, String playerName, String groupName); public boolean playerAddGroup(String worldName, String playerName, String groupName);
@ -115,7 +113,7 @@ public interface Permission {
* @param worldName Name of World * @param worldName Name of World
* @param playerName Name of Player * @param playerName Name of Player
* @param groupName Name of Group * @param groupName Name of Group
* @return * @return Success or Failure
*/ */
public boolean playerRemoveGroup(String worldName, String playerName, String groupName); public boolean playerRemoveGroup(String worldName, String playerName, String groupName);
@ -125,7 +123,7 @@ public interface Permission {
* @param playerName Name of Player * @param playerName Name of Player
* @param node Permission node * @param node Permission node
* @param defaultValue Default value (if node is not defined) * @param defaultValue Default value (if node is not defined)
* @return * @return Value
*/ */
public int getPlayerInfoInteger(String world, String playerName, String node, int defaultValue); public int getPlayerInfoInteger(String world, String playerName, String node, int defaultValue);
@ -144,7 +142,7 @@ public interface Permission {
* @param groupName Name of Group * @param groupName Name of Group
* @param node Permission node * @param node Permission node
* @param defaultValue Default value (if node is not defined) * @param defaultValue Default value (if node is not defined)
* @return * @return Value
*/ */
public int getGroupInfoInteger(String world, String groupName, String node, int defaultValue); public int getGroupInfoInteger(String world, String groupName, String node, int defaultValue);
@ -164,7 +162,7 @@ public interface Permission {
* @param playerName Name of Group * @param playerName Name of Group
* @param node Permission node * @param node Permission node
* @param defaultValue Default value (if node is not defined) * @param defaultValue Default value (if node is not defined)
* @return * @return Value
*/ */
public double getPlayerInfoDouble(String world, String playerName, String node, double defaultValue); public double getPlayerInfoDouble(String world, String playerName, String node, double defaultValue);
@ -183,7 +181,7 @@ public interface Permission {
* @param groupName Name of Group * @param groupName Name of Group
* @param node Permission node * @param node Permission node
* @param defaultValue Default value (if node is not defined) * @param defaultValue Default value (if node is not defined)
* @return * @return Value
*/ */
public double getGroupInfoDouble(String world, String groupName, String node, double defaultValue); public double getGroupInfoDouble(String world, String groupName, String node, double defaultValue);
@ -202,7 +200,7 @@ public interface Permission {
* @param playerName Name of Player * @param playerName Name of Player
* @param node Permission node * @param node Permission node
* @param defaultValue Default value (if node is not defined) * @param defaultValue Default value (if node is not defined)
* @return * @return Value
*/ */
public boolean getPlayerInfoBoolean(String world, String playerName, String node, boolean defaultValue); public boolean getPlayerInfoBoolean(String world, String playerName, String node, boolean defaultValue);
@ -221,7 +219,7 @@ public interface Permission {
* @param groupName Name of Group * @param groupName Name of Group
* @param node Permission node * @param node Permission node
* @param defaultValue Default value (if node is not defined) * @param defaultValue Default value (if node is not defined)
* @return * @return Value
*/ */
public boolean getGroupInfoBoolean(String world, String groupName, String node, boolean defaultValue); public boolean getGroupInfoBoolean(String world, String groupName, String node, boolean defaultValue);
@ -240,7 +238,7 @@ public interface Permission {
* @param playerName Name of Player * @param playerName Name of Player
* @param node Permission node * @param node Permission node
* @param defaultValue Default value (if node is not defined) * @param defaultValue Default value (if node is not defined)
* @return * @return Value
*/ */
public String getPlayerInfoString(String world, String playerName, String node, String defaultValue); public String getPlayerInfoString(String world, String playerName, String node, String defaultValue);
@ -259,7 +257,7 @@ public interface Permission {
* @param groupName Name of Group * @param groupName Name of Group
* @param node Permission node * @param node Permission node
* @param defaultValue Default value (if node is not defined) * @param defaultValue Default value (if node is not defined)
* @return * @return Value
*/ */
public String getGroupInfoString(String world, String groupName, String node, String defaultValue); public String getGroupInfoString(String world, String groupName, String node, String defaultValue);

View File

@ -19,6 +19,8 @@
package net.milkbowl.vault.permission.plugins; package net.milkbowl.vault.permission.plugins;
import java.util.logging.Logger;
import net.milkbowl.vault.permission.Permission; import net.milkbowl.vault.permission.Permission;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
@ -36,6 +38,8 @@ import com.nijiko.permissions.Group;
import com.nijikokun.bukkit.Permissions.Permissions; import com.nijikokun.bukkit.Permissions.Permissions;
public class Permission_Permissions implements Permission { public class Permission_Permissions implements Permission {
private static final Logger log = Logger.getLogger("Minecraft");
private String name = "Permissions (Phoenix)"; private String name = "Permissions (Phoenix)";
private Plugin plugin = null; private Plugin plugin = null;
private PluginManager pluginManager = null; private PluginManager pluginManager = null;

View File

@ -19,6 +19,8 @@
package net.milkbowl.vault.permission.plugins; package net.milkbowl.vault.permission.plugins;
import java.util.logging.Logger;
import net.milkbowl.vault.permission.Permission; import net.milkbowl.vault.permission.Permission;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
@ -36,6 +38,8 @@ import ru.tehkode.permissions.PermissionUser;
import ru.tehkode.permissions.bukkit.PermissionsEx; import ru.tehkode.permissions.bukkit.PermissionsEx;
public class Permission_PermissionsEx implements Permission { public class Permission_PermissionsEx implements Permission {
private static final Logger log = Logger.getLogger("Minecraft");
private String name = "PermissionsEx"; private String name = "PermissionsEx";
private Plugin plugin = null; private Plugin plugin = null;
private PluginManager pluginManager = null; private PluginManager pluginManager = null;