From 37a815d52ab3810daa379b1bc77175eaed0f6005 Mon Sep 17 00:00:00 2001 From: AlexTheCoder Date: Sat, 30 Apr 2016 14:41:28 -0400 Subject: [PATCH] Update JavaDocs to fit Mineplex standard --- .../src/mineplex/core/elo/EloManager.java | 22 ++++++++++++++----- 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/Plugins/Mineplex.Core/src/mineplex/core/elo/EloManager.java b/Plugins/Mineplex.Core/src/mineplex/core/elo/EloManager.java index b20218d20..7edbd8363 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/elo/EloManager.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/elo/EloManager.java @@ -141,7 +141,9 @@ public class EloManager extends MiniDbClientPlugin } /** - * Method for quickly checking if a player is banned from ranked games async + * Checks if a player is banned from ranked games async + * @param accountId The player's account ID + * @param afterCheck Code to be executed with the fetched ban status */ public void checkRankBannedAsync(int accountId, Callback afterCheck) { @@ -163,7 +165,9 @@ public class EloManager extends MiniDbClientPlugin } /** - * Method for quickly checking if a player is banned from ranked games (Should not be run on main thread) + * Checks if a player is banned from ranked games (Should not be run on main thread) + * @param accountId The player's account ID + * @return The ban status of the player */ public boolean checkRankBanned(int accountId) { @@ -183,7 +187,9 @@ public class EloManager extends MiniDbClientPlugin } /** - * Method for getting a player's remaining ranked game ban duration (Should not be run on main thread) + * Gets a player's remaining ranked game ban duration (Should not be run on main thread) + * @param accountId The player's account ID + * @return The ban expiry of the player (0 if not found) */ public long getRankBanExpiry(int accountId) { @@ -191,7 +197,9 @@ public class EloManager extends MiniDbClientPlugin } /** - * Method for getting a player's remaining ranked game ban duration if applicable async + * Gets a player's remaining ranked game ban duration if applicable async + * @param accountId The player's account ID + * @param afterFetch Code to be executed with the fetched ban expiration */ public void getRankBanExpiryAsync(int accountId, Callback afterFetch) { @@ -199,7 +207,8 @@ public class EloManager extends MiniDbClientPlugin } /** - * Method for banning a player from joining ranked games temporarily + * Bans a player from joining ranked games temporarily + * @param accountId The player's account ID */ public void banFromRanked(int accountId) { @@ -207,7 +216,8 @@ public class EloManager extends MiniDbClientPlugin } /** - * Method called when game ends to calculate new Elo and award it + * Called when game ends to calculate new Elo and award it + * @param gameId The game's ID */ public void endMatch(int gameId) {