From 57e9cd6e1972243bd2721a26f728b32be0213d9c Mon Sep 17 00:00:00 2001 From: Keir Nellyer Date: Sun, 24 Apr 2016 17:10:29 +0100 Subject: [PATCH] Add class headers and remove @author tags This makes the PR compliant with with the Mineplex coding style. Class headers are used to describe the function of a class and git history will be used to determine the author of a class. --- .../Mineplex.Core/src/mineplex/core/chatsnap/MessageType.java | 4 ++-- .../Mineplex.Core/src/mineplex/core/chatsnap/Snapshot.java | 1 - .../src/mineplex/core/chatsnap/SnapshotManager.java | 1 - .../src/mineplex/core/chatsnap/SnapshotPlugin.java | 2 +- .../src/mineplex/core/chatsnap/commands/ChatCacheCommand.java | 1 - .../core/chatsnap/publishing/LocalDateTimeSerializer.java | 2 +- .../mineplex/core/chatsnap/publishing/ReportSerializer.java | 2 +- .../mineplex/core/chatsnap/publishing/SnapshotPublisher.java | 2 +- .../src/mineplex/core/report/ReportCategory.java | 1 - .../core/report/command/ReportHandlerNotification.java | 1 - .../core/report/command/ReportNotificationCallback.java | 1 - .../mineplex/core/report/task/ReportHandlerMessageTask.java | 1 - .../src/mineplex/core/report/task/ReportPurgeTask.java | 1 - .../src/mineplex/core/report/ui/ReportCategoryButton.java | 1 - .../src/mineplex/core/report/ui/ReportCategoryPage.java | 1 - .../src/mineplex/core/report/ui/ReportResultButton.java | 1 - .../src/mineplex/core/report/ui/ReportResultPage.java | 1 - .../src/mineplex/reportserver/FilePurger.java | 2 +- .../src/mineplex/reportserver/RedisCommandHandler.java | 2 +- .../src/mineplex/reportserver/RedisConnectionHandler.java | 2 +- .../src/mineplex/reportserver/ReportServer.java | 2 +- 21 files changed, 10 insertions(+), 22 deletions(-) diff --git a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/MessageType.java b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/MessageType.java index 6effe0b12..22d71e314 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/MessageType.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/MessageType.java @@ -1,10 +1,10 @@ package mineplex.core.chatsnap; /** - * @author iKeirNez + * Holds all types of messages a player can receive from another player */ public enum MessageType { CHAT, - PM; + PM } diff --git a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/Snapshot.java b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/Snapshot.java index f7ccb890e..ba19a93d4 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/Snapshot.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/Snapshot.java @@ -15,7 +15,6 @@ import static com.google.common.base.Preconditions.checkNotNull; /** * Represents a message sent by a player. - * @author iKeirNez */ public class Snapshot implements Comparable { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/SnapshotManager.java b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/SnapshotManager.java index 9c73f90d4..e794d1495 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/SnapshotManager.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/SnapshotManager.java @@ -12,7 +12,6 @@ import mineplex.core.chatsnap.publishing.SnapshotPublisher; /** * Handles temporary storage of {@link Snapshot} instances. - * @author iKeirNez */ public class SnapshotManager { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/SnapshotPlugin.java b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/SnapshotPlugin.java index ec014465e..366cdff25 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/SnapshotPlugin.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/SnapshotPlugin.java @@ -15,7 +15,7 @@ import mineplex.core.chatsnap.commands.ChatCacheCommand; import mineplex.core.message.PrivateMessageEvent; /** - * @author iKeirNez + * Starter class for all snapshot related functions (ie capturing messages, retrieving snapshots). */ public class SnapshotPlugin extends MiniPlugin { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/commands/ChatCacheCommand.java b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/commands/ChatCacheCommand.java index 9c51ecac7..985c8db34 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/commands/ChatCacheCommand.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/commands/ChatCacheCommand.java @@ -15,7 +15,6 @@ import mineplex.core.common.util.UtilPlayer; /** * Displays what chat messages we have cached for a player. - * @author iKeirNez */ public class ChatCacheCommand extends CommandBase { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/publishing/LocalDateTimeSerializer.java b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/publishing/LocalDateTimeSerializer.java index 5a9366c14..9b309f9a9 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/publishing/LocalDateTimeSerializer.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/publishing/LocalDateTimeSerializer.java @@ -12,7 +12,7 @@ import com.google.gson.JsonSerializationContext; import com.google.gson.JsonSerializer; /** - * @author iKeirNez + * Handles serialization of Java 8's {@link LocalDateTime}. */ public class LocalDateTimeSerializer implements JsonSerializer { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/publishing/ReportSerializer.java b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/publishing/ReportSerializer.java index 8e14cbb78..969a1f357 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/publishing/ReportSerializer.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/publishing/ReportSerializer.java @@ -9,7 +9,7 @@ import com.google.gson.JsonSerializer; import mineplex.core.report.Report; /** - * @author iKeirNez + * Handles serialization of {@link Report} instances. */ public class ReportSerializer implements JsonSerializer { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/publishing/SnapshotPublisher.java b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/publishing/SnapshotPublisher.java index 72879ec82..12452f947 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/publishing/SnapshotPublisher.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/chatsnap/publishing/SnapshotPublisher.java @@ -24,7 +24,7 @@ import redis.clients.jedis.Jedis; import redis.clients.jedis.JedisPool; /** - * @author iKeirNez + * Class responsible for publishing snapshots on the website via Redis and a separate Report server. */ public class SnapshotPublisher { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/ReportCategory.java b/Plugins/Mineplex.Core/src/mineplex/core/report/ReportCategory.java index 800937aed..6f355b69a 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/report/ReportCategory.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/report/ReportCategory.java @@ -9,7 +9,6 @@ import mineplex.core.common.util.C; /** * Contains the reasons a player can be reported for. - * @author iKeirNez */ public enum ReportCategory { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/command/ReportHandlerNotification.java b/Plugins/Mineplex.Core/src/mineplex/core/report/command/ReportHandlerNotification.java index 585d85341..f6d127df2 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/report/command/ReportHandlerNotification.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/report/command/ReportHandlerNotification.java @@ -5,7 +5,6 @@ import mineplex.core.report.Report; /** * A message regarding a report which is sent only to the player handling the report. - * @author iKeirNez */ public class ReportHandlerNotification extends ReportNotification { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/command/ReportNotificationCallback.java b/Plugins/Mineplex.Core/src/mineplex/core/report/command/ReportNotificationCallback.java index e584cb957..e77fc2cb0 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/report/command/ReportNotificationCallback.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/report/command/ReportNotificationCallback.java @@ -14,7 +14,6 @@ import mineplex.serverdata.commands.ServerCommand; /** * Handles receiving of report notifications. - * @author iKeirNez */ public class ReportNotificationCallback implements CommandCallback { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/task/ReportHandlerMessageTask.java b/Plugins/Mineplex.Core/src/mineplex/core/report/task/ReportHandlerMessageTask.java index f9ec06cdd..34677f603 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/report/task/ReportHandlerMessageTask.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/report/task/ReportHandlerMessageTask.java @@ -17,7 +17,6 @@ import org.apache.commons.lang3.StringUtils; /** * Displays a message containing up-to-date details of a report to it's handler. - * @author iKeirNez */ public class ReportHandlerMessageTask extends BukkitRunnable { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/task/ReportPurgeTask.java b/Plugins/Mineplex.Core/src/mineplex/core/report/task/ReportPurgeTask.java index 6dbd6be78..558d67f76 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/report/task/ReportPurgeTask.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/report/task/ReportPurgeTask.java @@ -8,7 +8,6 @@ import mineplex.core.report.ReportManager; /** * Checks reports "owned" by this instance for inactivity, purges inactive reports. - * @author iKeirNez */ public class ReportPurgeTask extends BukkitRunnable { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportCategoryButton.java b/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportCategoryButton.java index 1067fc08f..cece67fa7 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportCategoryButton.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportCategoryButton.java @@ -8,7 +8,6 @@ import mineplex.core.report.ReportCategory; /** * Represents a clickable button in a {@link ReportCategoryPage} which determines the type of infraction a player has committed. - * @author iKeirNez */ public class ReportCategoryButton extends SimpleGuiItem { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportCategoryPage.java b/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportCategoryPage.java index fe3bdf26d..1112d2892 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportCategoryPage.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportCategoryPage.java @@ -15,7 +15,6 @@ import mineplex.core.report.ReportPlugin; /** * User interface shown to a player when reporting another player. - * @author iKeirNez */ public class ReportCategoryPage extends SimpleGui { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportResultButton.java b/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportResultButton.java index 4a28efe14..71ab832de 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportResultButton.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportResultButton.java @@ -11,7 +11,6 @@ import mineplex.core.report.ReportResult; /** * Represents a button which can be clicked to determine the result of a report. - * @author iKeirNez */ public class ReportResultButton extends SimpleGuiItem { diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportResultPage.java b/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportResultPage.java index 6ee2ad4f2..bbf859821 100644 --- a/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportResultPage.java +++ b/Plugins/Mineplex.Core/src/mineplex/core/report/ui/ReportResultPage.java @@ -15,7 +15,6 @@ import mineplex.core.report.ReportResult; /** * User interface shown to a moderator when closing a report to determine the result of the report. - * @author iKeirNez */ public class ReportResultPage extends SimpleGui { diff --git a/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/FilePurger.java b/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/FilePurger.java index 4f6d097a2..7d61e3b26 100644 --- a/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/FilePurger.java +++ b/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/FilePurger.java @@ -8,7 +8,7 @@ import java.util.logging.Logger; import org.apache.commons.lang3.Validate; /** - * @author iKeirNez + * Class responsible for deleting old files (file age is determined by the "last modified" value). */ public class FilePurger implements Runnable { diff --git a/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/RedisCommandHandler.java b/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/RedisCommandHandler.java index e6656c822..6afe71a6a 100644 --- a/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/RedisCommandHandler.java +++ b/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/RedisCommandHandler.java @@ -20,7 +20,7 @@ import org.apache.commons.lang3.Validate; import redis.clients.jedis.JedisPubSub; /** - * @author iKeirNez + * Listens for commands from Redis (such as "deploy" or "destroy") and executes them. */ public class RedisCommandHandler extends JedisPubSub { diff --git a/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/RedisConnectionHandler.java b/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/RedisConnectionHandler.java index df5b8346f..ac4c2fa42 100644 --- a/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/RedisConnectionHandler.java +++ b/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/RedisConnectionHandler.java @@ -9,7 +9,7 @@ import redis.clients.jedis.Jedis; import redis.clients.jedis.JedisPool; /** - * @author iKeirNez + * Establishes and maintains a connection to Redis. */ public class RedisConnectionHandler implements Runnable { diff --git a/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/ReportServer.java b/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/ReportServer.java index e1a2de33d..2c101107a 100644 --- a/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/ReportServer.java +++ b/Plugins/Mineplex.ReportServer/src/mineplex/reportserver/ReportServer.java @@ -21,7 +21,7 @@ import org.apache.commons.lang3.Validate; import redis.clients.jedis.JedisPool; /** - * @author iKeirNez + * Main class for the Report server, parses command line arguments and initializes the Report server. */ public class ReportServer {