From cefba8b2aeb83173bb0953e933d9ed8761b52d9b Mon Sep 17 00:00:00 2001 From: thmsdy Date: Fri, 17 Jan 2020 21:58:53 -0600 Subject: [PATCH] Improve command documentation --- dependency-reduced-pom.xml | 2 +- pom.xml | 2 +- .../com/fpghoti/fpchatx/command/commands/BadgeEquipCommand.java | 2 +- .../com/fpghoti/fpchatx/command/commands/BadgeListCommand.java | 2 +- .../com/fpghoti/fpchatx/command/commands/BlacklistCommand.java | 2 +- .../com/fpghoti/fpchatx/command/commands/ChannelsCommand.java | 2 +- .../com/fpghoti/fpchatx/command/commands/CreateCommand.java | 2 +- .../com/fpghoti/fpchatx/command/commands/DeleteCommand.java | 2 +- .../com/fpghoti/fpchatx/command/commands/GiveBadgeCommand.java | 2 +- .../java/com/fpghoti/fpchatx/command/commands/HelpCommand.java | 2 +- .../java/com/fpghoti/fpchatx/command/commands/HushCommand.java | 2 +- .../com/fpghoti/fpchatx/command/commands/IgnoreCommand.java | 2 +- .../com/fpghoti/fpchatx/command/commands/IgnoreListCommand.java | 2 +- .../java/com/fpghoti/fpchatx/command/commands/JoinCommand.java | 2 +- .../java/com/fpghoti/fpchatx/command/commands/KickCommand.java | 2 +- .../java/com/fpghoti/fpchatx/command/commands/LeaveCommand.java | 2 +- .../com/fpghoti/fpchatx/command/commands/MessageCommand.java | 2 +- .../java/com/fpghoti/fpchatx/command/commands/ReplyCommand.java | 2 +- .../fpghoti/fpchatx/command/commands/RevokeBadgeCommand.java | 2 +- .../java/com/fpghoti/fpchatx/command/commands/ShoutCommand.java | 2 +- .../fpghoti/fpchatx/command/commands/ShoutToggleCommand.java | 2 +- .../java/com/fpghoti/fpchatx/command/commands/SpyCommand.java | 2 +- .../java/com/fpghoti/fpchatx/command/commands/TalkCommand.java | 2 +- .../com/fpghoti/fpchatx/command/commands/UnHushCommand.java | 2 +- .../com/fpghoti/fpchatx/command/commands/UnignoreCommand.java | 2 +- .../java/com/fpghoti/fpchatx/command/commands/WhoCommand.java | 2 +- 26 files changed, 26 insertions(+), 26 deletions(-) diff --git a/dependency-reduced-pom.xml b/dependency-reduced-pom.xml index d48e621..f0be312 100644 --- a/dependency-reduced-pom.xml +++ b/dependency-reduced-pom.xml @@ -3,7 +3,7 @@ 4.0.0 FPChatX FPChatX - 1.0.0-BETA + 1.0.1-BETA src/main/java diff --git a/pom.xml b/pom.xml index cba7862..5f6c68e 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ 4.0.0 FPChatX FPChatX - 1.0.0-BETA + 1.0.1-BETA spigot-repo diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/BadgeEquipCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/BadgeEquipCommand.java index f3af7f5..95c9cf4 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/BadgeEquipCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/BadgeEquipCommand.java @@ -18,7 +18,7 @@ public class BadgeEquipCommand extends Commands { super(plugin); name = "BadgeEquip"; description = "Equips badges for use in chat"; - syntax = ChatColor.GRAY + "/equip " + ChatColor.GOLD + "slot# badge#"; + syntax = ChatColor.GRAY + "/equip " + ChatColor.GOLD + " "; minArgs = 2; maxArgs = 2; labels.add("fpc badgeequip"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/BadgeListCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/BadgeListCommand.java index ea72fa8..5074d42 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/BadgeListCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/BadgeListCommand.java @@ -16,7 +16,7 @@ public class BadgeListCommand extends Commands { super(plugin); name = "BadgeList"; description = "Pulls up a list of badges you own"; - syntax = ChatColor.GRAY + "/badgelist " + ChatColor.GOLD + "[page#]"; + syntax = ChatColor.GRAY + "/badgelist " + ChatColor.GOLD + "[page number]"; minArgs = 0; maxArgs = 1; labels.add("fpc badgelist"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/BlacklistCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/BlacklistCommand.java index d9410b1..d8b1b58 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/BlacklistCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/BlacklistCommand.java @@ -21,7 +21,7 @@ public class BlacklistCommand extends Commands { super(plugin); name = "Blacklist"; description = "Toggles blacklisted status of a player in a specific channel"; - syntax = ChatColor.GRAY + "/fpc blacklist " + ChatColor.GOLD + "channel player"; + syntax = ChatColor.GRAY + "/fpc blacklist " + ChatColor.GOLD + " "; minArgs = 1; maxArgs = 2; labels.add("fpc blacklist"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/ChannelsCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/ChannelsCommand.java index ddc1f53..ec6e820 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/ChannelsCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/ChannelsCommand.java @@ -20,7 +20,7 @@ public class ChannelsCommand extends Commands { super(plugin); name = "Channels"; description = "Lists all open channels"; - syntax = ChatColor.GRAY + "/fpc channels " + ChatColor.GOLD + "[page#]"; + syntax = ChatColor.GRAY + "/fpc channels " + ChatColor.GOLD + "[page number]"; minArgs = 0; maxArgs = 1; labels.add("fpc channels"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/CreateCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/CreateCommand.java index 1be2eaa..7d92b4b 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/CreateCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/CreateCommand.java @@ -21,7 +21,7 @@ public class CreateCommand extends Commands { super(plugin); name = "Create"; description = "Makes a new channel"; - syntax = ChatColor.GRAY + "/fpc create " + ChatColor.GOLD + " name "; + syntax = ChatColor.GRAY + "/fpc create " + ChatColor.GOLD + "[temp] [flags]"; minArgs = 1; maxArgs = 2 + validflags.length; labels.add("fpc create"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/DeleteCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/DeleteCommand.java index 41e7697..b6f668a 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/DeleteCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/DeleteCommand.java @@ -17,7 +17,7 @@ public class DeleteCommand extends Commands { super(plugin); name = "Delete"; description = "Deletes a channel"; - syntax = ChatColor.GRAY + "/fpc delete " + ChatColor.GOLD + "channel"; + syntax = ChatColor.GRAY + "/fpc delete " + ChatColor.GOLD + ""; minArgs = 1; maxArgs = 1; labels.add("fpc delete"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/GiveBadgeCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/GiveBadgeCommand.java index 497a50e..d50ce5c 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/GiveBadgeCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/GiveBadgeCommand.java @@ -18,7 +18,7 @@ public class GiveBadgeCommand extends Commands { super(plugin); name = "GiveBadge"; description = "Give player a badge"; - syntax = ChatColor.GRAY + "/givebadge " + ChatColor.GOLD + "player badge#"; + syntax = ChatColor.GRAY + "/givebadge " + ChatColor.GOLD + " "; minArgs = 2; maxArgs = 2; labels.add("fpc givebadge"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/HelpCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/HelpCommand.java index 08704c2..7c855ed 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/HelpCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/HelpCommand.java @@ -18,7 +18,7 @@ public class HelpCommand extends Commands { super(plugin); name = "Help"; description = "Displays the help menu"; - syntax = ChatColor.GRAY + "/fpc help " + ChatColor.GOLD + "page#"; + syntax = ChatColor.GRAY + "/fpc help " + ChatColor.GOLD + "[page numer]"; minArgs = 0; maxArgs = 1; labels.add("fpc help"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/HushCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/HushCommand.java index b1d14c3..e09595a 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/HushCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/HushCommand.java @@ -15,7 +15,7 @@ public class HushCommand extends Commands { super(plugin); name = "Hush"; description = "Prevents a player from shouting"; - syntax = ChatColor.GRAY + "/hush " + ChatColor.GOLD + "player"; + syntax = ChatColor.GRAY + "/hush " + ChatColor.GOLD + ""; minArgs = 1; maxArgs = 1; labels.add("fpc hush"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/IgnoreCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/IgnoreCommand.java index e944ed7..fdd7b92 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/IgnoreCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/IgnoreCommand.java @@ -19,7 +19,7 @@ public class IgnoreCommand extends Commands { super(plugin); name = "Ignore"; description = "Ignores all messages from a player"; - syntax = ChatColor.GRAY + "/ignore " + ChatColor.GOLD + "player"; + syntax = ChatColor.GRAY + "/ignore " + ChatColor.GOLD + ""; minArgs = 1; maxArgs = 1; labels.add("fpc ignore"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/IgnoreListCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/IgnoreListCommand.java index f29a41c..4e6e055 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/IgnoreListCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/IgnoreListCommand.java @@ -20,7 +20,7 @@ public class IgnoreListCommand extends Commands { super(plugin); name = "Ignore List"; description = "Lists all players you have ignored"; - syntax = ChatColor.GRAY + "/ignorelist " + ChatColor.GOLD + "[page#]"; + syntax = ChatColor.GRAY + "/ignorelist " + ChatColor.GOLD + "[page number]"; minArgs = 0; maxArgs = 1; labels.add("fpc ignorelist"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/JoinCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/JoinCommand.java index 1253480..ca3d662 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/JoinCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/JoinCommand.java @@ -15,7 +15,7 @@ public class JoinCommand extends Commands { super(plugin); name = "Join"; description = "Enters a channel"; - syntax = ChatColor.GRAY + "/fpc join " + ChatColor.GOLD + "channel"; + syntax = ChatColor.GRAY + "/fpc join " + ChatColor.GOLD + ""; minArgs = 1; maxArgs = 1; labels.add("fpc join"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/KickCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/KickCommand.java index cf926c8..539a72f 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/KickCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/KickCommand.java @@ -18,7 +18,7 @@ public class KickCommand extends Commands { super(plugin); name = "Kick"; description = "Kicks a player from a channel"; - syntax = ChatColor.GRAY + "/fpc kick " + ChatColor.GOLD + "channel player"; + syntax = ChatColor.GRAY + "/fpc kick " + ChatColor.GOLD + " "; minArgs = 2; maxArgs = 2; labels.add("fpc kick"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/LeaveCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/LeaveCommand.java index a3c7266..74d74e9 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/LeaveCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/LeaveCommand.java @@ -15,7 +15,7 @@ public class LeaveCommand extends Commands { super(plugin); name = "Leave"; description = "Leaves a channel"; - syntax = ChatColor.GRAY + "/fpc leave " + ChatColor.GOLD + "channel"; + syntax = ChatColor.GRAY + "/fpc leave " + ChatColor.GOLD + ""; minArgs = 1; maxArgs = 1; labels.add("fpc leave"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/MessageCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/MessageCommand.java index b88769e..e2ce184 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/MessageCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/MessageCommand.java @@ -18,7 +18,7 @@ public class MessageCommand extends Commands { super(plugin); name = "Message"; description = "Sends a private message to another player"; - syntax = ChatColor.GRAY + "/msg " + ChatColor.GOLD + "player message"; + syntax = ChatColor.GRAY + "/msg " + ChatColor.GOLD + " "; minArgs = 2; maxArgs = 100000; labels.add("msg"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/ReplyCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/ReplyCommand.java index 34d50b4..f2a329f 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/ReplyCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/ReplyCommand.java @@ -15,7 +15,7 @@ public class ReplyCommand extends Commands { super(plugin); name = "Reply"; description = "Reply to a PM from another player"; - syntax = ChatColor.GRAY + "/r " + ChatColor.GOLD + "message"; + syntax = ChatColor.GRAY + "/r " + ChatColor.GOLD + ""; minArgs = 1; maxArgs = 10000; labels.add("reply"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/RevokeBadgeCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/RevokeBadgeCommand.java index 59c025c..27463e2 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/RevokeBadgeCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/RevokeBadgeCommand.java @@ -23,7 +23,7 @@ public class RevokeBadgeCommand extends Commands { super(plugin); name = "RevokeBadge"; description = "Revokes badge from player"; - syntax = ChatColor.GRAY + "/revokebadge " + ChatColor.GOLD + "player badge#"; + syntax = ChatColor.GRAY + "/revokebadge " + ChatColor.GOLD + " "; minArgs = 2; maxArgs = 2; labels.add("fpc revokebadge"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/ShoutCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/ShoutCommand.java index ce21d83..f34da38 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/ShoutCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/ShoutCommand.java @@ -14,7 +14,7 @@ public class ShoutCommand extends Commands { super(plugin); name = "Shout"; description = "Sends a chat message to every online player"; - syntax = ChatColor.GRAY + "/shout " + ChatColor.GOLD + "msg"; + syntax = ChatColor.GRAY + "/shout " + ChatColor.GOLD + ""; minArgs = 0; maxArgs = 100000; labels.add("fpc shout"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/ShoutToggleCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/ShoutToggleCommand.java index ab9ae0d..cb401ee 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/ShoutToggleCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/ShoutToggleCommand.java @@ -15,7 +15,7 @@ public class ShoutToggleCommand extends Commands { super(plugin); name = "ShoutToggle"; description = "Temporarily enables or disables shout"; - syntax = ChatColor.GRAY + "/fpc shouttoggle " + ChatColor.GOLD + "channel"; + syntax = ChatColor.GRAY + "/shouttoggle"; minArgs = 0; maxArgs = 0; labels.add("fpc shouttoggle"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/SpyCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/SpyCommand.java index 92d1fb9..d2c6ead 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/SpyCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/SpyCommand.java @@ -17,7 +17,7 @@ public class SpyCommand extends Commands{ super(plugin); name = "Spy"; description = "Toggles Spy mode"; - syntax = ChatColor.GRAY + "/spy " + ChatColor.GOLD + "on/off"; + syntax = ChatColor.GRAY + "/spy " + ChatColor.GOLD + "{on|off}"; minArgs = 1; maxArgs = 1; labels.add("spy"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/TalkCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/TalkCommand.java index 37ce03e..345072e 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/TalkCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/TalkCommand.java @@ -22,7 +22,7 @@ public class TalkCommand extends Commands { super(plugin); name = "Talk"; description = "Talk in a specific channel"; - syntax = ChatColor.GRAY + "/talk " + ChatColor.GOLD + "channel [msg]"; + syntax = ChatColor.GRAY + "/talk " + ChatColor.GOLD + " [message]"; minArgs = 1; maxArgs = 100000; labels.add("fpc talk"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/UnHushCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/UnHushCommand.java index 76d43c3..ee640f2 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/UnHushCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/UnHushCommand.java @@ -15,7 +15,7 @@ public class UnHushCommand extends Commands { super(plugin); name = "UnHush"; description = "Unhushes a player"; - syntax = ChatColor.GRAY + "/unhush " + ChatColor.GOLD + "player"; + syntax = ChatColor.GRAY + "/unhush " + ChatColor.GOLD + ""; minArgs = 1; maxArgs = 1; labels.add("fpc unhush"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/UnignoreCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/UnignoreCommand.java index c8bfb29..dbed9fb 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/UnignoreCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/UnignoreCommand.java @@ -18,7 +18,7 @@ public class UnignoreCommand extends Commands { super(plugin); name = "Unignore"; description = "Unignores all messages from a player"; - syntax = ChatColor.GRAY + "/unignore " + ChatColor.GOLD + "player"; + syntax = ChatColor.GRAY + "/unignore " + ChatColor.GOLD + ""; minArgs = 1; maxArgs = 1; labels.add("fpc unignore"); diff --git a/src/main/java/com/fpghoti/fpchatx/command/commands/WhoCommand.java b/src/main/java/com/fpghoti/fpchatx/command/commands/WhoCommand.java index 44b0dee..cdd04aa 100644 --- a/src/main/java/com/fpghoti/fpchatx/command/commands/WhoCommand.java +++ b/src/main/java/com/fpghoti/fpchatx/command/commands/WhoCommand.java @@ -19,7 +19,7 @@ public class WhoCommand extends Commands { super(plugin); name = "Who"; description = "Lists all players in your primary channel"; - syntax = ChatColor.GRAY + "/fpc who " + ChatColor.GOLD + "[page#]"; + syntax = ChatColor.GRAY + "/fpc who " + ChatColor.GOLD + "[page number]"; minArgs = 0; maxArgs = 1; labels.add("fpc who");