From eab883a052f268a40493af6f7b558c2040d67e21 Mon Sep 17 00:00:00 2001 From: gomeow Date: Sat, 12 Oct 2013 12:04:08 -0700 Subject: [PATCH] Javadoc revisions --- .../java/com/drtshock/playervaults/PlayerVaults.java | 5 ++++- .../drtshock/playervaults/listeners/Listeners.java | 12 ++++++------ .../playervaults/util/EconomyOperations.java | 2 ++ 3 files changed, 12 insertions(+), 7 deletions(-) diff --git a/src/main/java/com/drtshock/playervaults/PlayerVaults.java b/src/main/java/com/drtshock/playervaults/PlayerVaults.java index e544d35..e008be7 100644 --- a/src/main/java/com/drtshock/playervaults/PlayerVaults.java +++ b/src/main/java/com/drtshock/playervaults/PlayerVaults.java @@ -77,6 +77,9 @@ public class PlayerVaults extends JavaPlugin { VM = new VaultManager(this); } + /** + * Start sending data to mcstats. + */ private void startMetrics() { try { Metrics metrics = new Metrics(this); @@ -130,7 +133,7 @@ public class PlayerVaults extends JavaPlugin { } /** - * Setup economy + * Setup economy. * * @return Whether or not economy exists. */ diff --git a/src/main/java/com/drtshock/playervaults/listeners/Listeners.java b/src/main/java/com/drtshock/playervaults/listeners/Listeners.java index 4fcc3b5..7fc340b 100644 --- a/src/main/java/com/drtshock/playervaults/listeners/Listeners.java +++ b/src/main/java/com/drtshock/playervaults/listeners/Listeners.java @@ -43,20 +43,20 @@ public class Listeners implements Listener { /** * Save a players vault. Sends to method in VaultManager class. * - * @param Player The player of whose vault to save + * @param player The player of whose vault to save */ - public void saveVault(Player p) { - if (PlayerVaults.IN_VAULT.containsKey(p.getName())) { - Inventory inv = p.getOpenInventory().getTopInventory(); + public void saveVault(Player player) { + if (PlayerVaults.IN_VAULT.containsKey(player.getName())) { + Inventory inv = player.getOpenInventory().getTopInventory(); if (inv.getViewers().size() == 1) { - VaultViewInfo info = PlayerVaults.IN_VAULT.get(p.getName()); + VaultViewInfo info = PlayerVaults.IN_VAULT.get(player.getName()); try { vm.saveVault(inv, info.getHolder(), info.getNumber()); } catch (IOException e) { } PlayerVaults.OPENINVENTORIES.remove(info.toString()); } - PlayerVaults.IN_VAULT.remove(p.getName()); + PlayerVaults.IN_VAULT.remove(player.getName()); } } diff --git a/src/main/java/com/drtshock/playervaults/util/EconomyOperations.java b/src/main/java/com/drtshock/playervaults/util/EconomyOperations.java index 375d87f..797c424 100644 --- a/src/main/java/com/drtshock/playervaults/util/EconomyOperations.java +++ b/src/main/java/com/drtshock/playervaults/util/EconomyOperations.java @@ -30,6 +30,7 @@ public class EconomyOperations { * Have a player pay to open a vault. * * @param player The player to pay. + * @param number The vault number to open. * @return The transaction success. */ public static boolean payToOpen(Player player, int number) { @@ -74,6 +75,7 @@ public class EconomyOperations { * Have a player get his money back when vault is deleted. * * @param player The player to receive the money. + * @param number The vault number to delete. * @return The transaction success. */ public static boolean refundOnDelete(Player player, int number) {