From 3d0bf674bdc3e6e6f51363098c28ce88c1c9075a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tim=20Vis=C3=A9e?= <timvisee@gmail.com>
Date: Tue, 1 Dec 2015 16:34:22 +0100
Subject: [PATCH] Added JavaDocs to PlayerPermission class, fixed various
 permission nodes

---
 .../authme/permission/PlayerPermission.java   | 69 +++++++++++++++++--
 1 file changed, 65 insertions(+), 4 deletions(-)

diff --git a/src/main/java/fr/xephi/authme/permission/PlayerPermission.java b/src/main/java/fr/xephi/authme/permission/PlayerPermission.java
index e44617f5..a125014a 100644
--- a/src/main/java/fr/xephi/authme/permission/PlayerPermission.java
+++ b/src/main/java/fr/xephi/authme/permission/PlayerPermission.java
@@ -1,49 +1,110 @@
 package fr.xephi.authme.permission;
 
 /**
- * AuthMe player command permission nodes, for regular players.
+ * AuthMe player permission nodes, for regular players.
  */
 public enum PlayerPermission implements PermissionNode {
 
-    BYPASS_ANTIBOT("authme.command.player.bypassantibot"),
+    /**
+     * Permission node to bypass AntiBot protection.
+     */
+    BYPASS_ANTIBOT("authme.player.bypassantibot"),
 
-    IS_VIP("authme.command.player.vip"),
+    /**
+     * Permission node to identify VIP users.
+     */
+    IS_VIP("authme.player.vip"),
 
+    /**
+     * Command permission to login.
+     */
     LOGIN("authme.command.player.login"),
 
+    /**
+     * Command permission to logout.
+     */
     LOGOUT("authme.command.player.logout"),
 
+    /**
+     * Command permission to register.
+     */
     REGISTER("authme.command.player.register"),
 
+    /**
+     * Command permission to unregister.
+     */
     UNREGISTER("authme.command.player.unregister"),
 
+    /**
+     * Command permission to change the password.
+     */
     CHANGE_PASSWORD("authme.command.player.changepassword"),
 
+    /**
+     * Command permission to add an email address.
+     */
     ADD_EMAIL("authme.command.player.email.add"),
 
+    /**
+     * Command permission to change the email address.
+     */
     CHANGE_EMAIL("authme.command.player.email.change"),
 
+    /**
+     * Command permission to recover an account using it's email address.
+     */
     RECOVER_EMAIL("authme.command.player.email.recover"),
 
+    /**
+     * Command permission to use captcha.
+     */
     CAPTCHA("authme.command.player.captcha"),
 
+    /**
+     * Administrator command to convert old or other data to AuthMe data.
+     */
     CONVERTER("authme.command.player.converter"),
 
-    CAN_LOGIN_BE_FORCED("authme.command.player.canbeforced"),
+    /**
+     * Permission for users a login can be forced to.
+     */
+    CAN_LOGIN_BE_FORCED("authme.player.canbeforced"),
 
+    /**
+     * Permission for users to bypass force-survival mode.
+     */
     BYPASS_FORCE_SURVIVAL("authme.command.player.bypassforcesurvival"),
 
+    /**
+     * Permission for users to allow two accounts.
+     */
     ALLOW_MULTIPLE_ACCOUNTS("authme.command.player.allow2accounts"),
 
+    /**
+     * Permission for user to see other accounts.
+     */
     SEE_OTHER_ACCOUNTS("authme.command.player.seeotheraccounts");
 
+    /**
+     * Permission node.
+     */
     private String node;
 
+    /**
+     * Get the permission node.
+     *
+     * @return Permission node.
+     */
     @Override
     public String getNode() {
         return node;
     }
 
+    /**
+     * Constructor.
+     *
+     * @param node Permission node.
+     */
     PlayerPermission(String node) {
         this.node = node;
     }