From 36e79a15041dc6fc59e836172edbe2fa7da0c720 Mon Sep 17 00:00:00 2001
From: Keir Nellyer <iKeirNez@Keirs-MBP.home>
Date: Thu, 7 Apr 2016 14:44:27 +0100
Subject: [PATCH] Add header to every class as per new coding standards.

---
 Plugins/Mineplex.Core/src/mineplex/core/report/Report.java    | 4 ++++
 .../src/mineplex/core/report/ReportCategory.java              | 2 +-
 .../Mineplex.Core/src/mineplex/core/report/ReportManager.java | 1 -
 .../Mineplex.Core/src/mineplex/core/report/ReportPlugin.java  | 3 +++
 .../src/mineplex/core/report/ReportRepository.java            | 3 +++
 .../Mineplex.Core/src/mineplex/core/report/ReportResult.java  | 3 +++
 6 files changed, 14 insertions(+), 2 deletions(-)

diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/Report.java b/Plugins/Mineplex.Core/src/mineplex/core/report/Report.java
index a295c01f0..d88dd528e 100644
--- a/Plugins/Mineplex.Core/src/mineplex/core/report/Report.java
+++ b/Plugins/Mineplex.Core/src/mineplex/core/report/Report.java
@@ -9,6 +9,10 @@ import java.util.concurrent.TimeUnit;
 import mineplex.serverdata.data.Data;
 import org.apache.commons.lang3.RandomStringUtils;
 
+/**
+ * Contains data about a report.
+ * Active/open reports have their instances are stored in Redis for cross-server access.
+ */
 public class Report implements Data
 {
 
diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/ReportCategory.java b/Plugins/Mineplex.Core/src/mineplex/core/report/ReportCategory.java
index 1aad207a1..800937aed 100644
--- a/Plugins/Mineplex.Core/src/mineplex/core/report/ReportCategory.java
+++ b/Plugins/Mineplex.Core/src/mineplex/core/report/ReportCategory.java
@@ -8,7 +8,7 @@ import org.bukkit.Material;
 import mineplex.core.common.util.C;
 
 /**
- * Contains all the reasons a player can be reported for.
+ * Contains the reasons a player can be reported for.
  * @author iKeirNez
  */
 public enum ReportCategory
diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/ReportManager.java b/Plugins/Mineplex.Core/src/mineplex/core/report/ReportManager.java
index b942b6d65..ba262a713 100644
--- a/Plugins/Mineplex.Core/src/mineplex/core/report/ReportManager.java
+++ b/Plugins/Mineplex.Core/src/mineplex/core/report/ReportManager.java
@@ -47,7 +47,6 @@ import redis.clients.jedis.exceptions.JedisConnectionException;
  * ReportManager hooks into a synchronized network-wide report system 
  * with methods for updating/fetching/closing reports in real time.
  * @author Ty, iKeirNez
- *
  */
 public class ReportManager {
 
diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/ReportPlugin.java b/Plugins/Mineplex.Core/src/mineplex/core/report/ReportPlugin.java
index 1567bc341..0bcfc8cef 100644
--- a/Plugins/Mineplex.Core/src/mineplex/core/report/ReportPlugin.java
+++ b/Plugins/Mineplex.Core/src/mineplex/core/report/ReportPlugin.java
@@ -11,6 +11,9 @@ import org.bukkit.event.player.PlayerJoinEvent;
 import org.bukkit.event.player.PlayerQuitEvent;
 import org.bukkit.plugin.java.JavaPlugin;
 
+/**
+ * Main class for this module, handles initialization and disabling of the module.
+ */
 public class ReportPlugin extends MiniPlugin 
 {
 	private final ReportManager _reportManager;
diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/ReportRepository.java b/Plugins/Mineplex.Core/src/mineplex/core/report/ReportRepository.java
index dcd4ace6e..246688673 100644
--- a/Plugins/Mineplex.Core/src/mineplex/core/report/ReportRepository.java
+++ b/Plugins/Mineplex.Core/src/mineplex/core/report/ReportRepository.java
@@ -9,6 +9,9 @@ import mineplex.serverdata.database.column.ColumnVarChar;
 
 import org.bukkit.plugin.java.JavaPlugin;
 
+/**
+ * Responsible for all database related operations for this module.
+ */
 public class ReportRepository extends MinecraftRepository
 {	
 	private static String CREATE_TICKET_TABLE = "CREATE TABLE IF NOT EXISTS reportTickets (reportId INT NOT NULL, eventDate LONG, playerId INT NOT NULL, server VARCHAR(50), closerId INT NOT NULL, result VARCHAR(25), reason VARCHAR(100), PRIMARY KEY (reportId), FOREIGN KEY (playerId) REFERENCES accounts(id), FOREIGN KEY (closerId) REFERENCES accounts(id));";
diff --git a/Plugins/Mineplex.Core/src/mineplex/core/report/ReportResult.java b/Plugins/Mineplex.Core/src/mineplex/core/report/ReportResult.java
index 37f8513b7..9d97e76eb 100644
--- a/Plugins/Mineplex.Core/src/mineplex/core/report/ReportResult.java
+++ b/Plugins/Mineplex.Core/src/mineplex/core/report/ReportResult.java
@@ -2,6 +2,9 @@ package mineplex.core.report;
 
 import org.bukkit.ChatColor;
 
+/**
+ * Contains all possible outcomes for a report.
+ */
 public enum ReportResult
 {
 	ACCEPTED("Global.AcceptedReportsCount", ChatColor.GREEN, "Accept Report (Punish Player)", "Accepted (Player Received Punishment)"),