thmsdy
/
FPChatX
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Improve command documentation

This commit is contained in:
Ghoti 2020-01-17 21:58:53 -06:00
parent 49a29a7420
commit cefba8b2ae
26 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
dependency-reduced-pom.xml
View File

@ -3,7 +3,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>FPChatX</groupId>
<artifactId>FPChatX</artifactId>
<version>1.0.0-BETA</version>
<version>1.0.1-BETA</version>
<build>
<sourceDirectory>src/main/java</sourceDirectory>
<resources>

2
pom.xml
View File

@ -4,7 +4,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>FPChatX</groupId>
<artifactId>FPChatX</artifactId>
<version>1.0.0-BETA</version>
<version>1.0.1-BETA</version>
<repositories>
<repository>
<id>spigot-repo</id>

2
src/main/java/com/fpghoti/fpchatx/command/commands/BadgeEquipCommand.java
View File

@ -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 + "<slot number> <badge number>";
minArgs = 2;
maxArgs = 2;
labels.add("fpc badgeequip");

2
src/main/java/com/fpghoti/fpchatx/command/commands/BadgeListCommand.java
View File

@ -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");

2
src/main/java/com/fpghoti/fpchatx/command/commands/BlacklistCommand.java
View File

@ -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 + "<channel> <player>";
minArgs = 1;
maxArgs = 2;
labels.add("fpc blacklist");

2
src/main/java/com/fpghoti/fpchatx/command/commands/ChannelsCommand.java
View File

@ -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");

2
src/main/java/com/fpghoti/fpchatx/command/commands/CreateCommand.java
View File

@ -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 + "<temp> name <flags>";
syntax = ChatColor.GRAY + "/fpc create " + ChatColor.GOLD + "[temp] <name> [flags]";
minArgs = 1;
maxArgs = 2 + validflags.length;
labels.add("fpc create");

2
src/main/java/com/fpghoti/fpchatx/command/commands/DeleteCommand.java
View File

@ -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 + "<channel>";
minArgs = 1;
maxArgs = 1;
labels.add("fpc delete");

2
src/main/java/com/fpghoti/fpchatx/command/commands/GiveBadgeCommand.java
View File

@ -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 + "<player> <badge number>";
minArgs = 2;
maxArgs = 2;
labels.add("fpc givebadge");

2
src/main/java/com/fpghoti/fpchatx/command/commands/HelpCommand.java
View File

@ -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");

2
src/main/java/com/fpghoti/fpchatx/command/commands/HushCommand.java
View File

@ -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 + "<player>";
minArgs = 1;
maxArgs = 1;
labels.add("fpc hush");

2
src/main/java/com/fpghoti/fpchatx/command/commands/IgnoreCommand.java
View File

@ -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 + "<player>";
minArgs = 1;
maxArgs = 1;
labels.add("fpc ignore");

2
src/main/java/com/fpghoti/fpchatx/command/commands/IgnoreListCommand.java
View File

@ -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");

2
src/main/java/com/fpghoti/fpchatx/command/commands/JoinCommand.java
View File

@ -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 + "<channel>";
minArgs = 1;
maxArgs = 1;
labels.add("fpc join");

2
src/main/java/com/fpghoti/fpchatx/command/commands/KickCommand.java
View File

@ -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 + "<channel> <player>";
minArgs = 2;
maxArgs = 2;
labels.add("fpc kick");

2
src/main/java/com/fpghoti/fpchatx/command/commands/LeaveCommand.java
View File

@ -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 + "<channel>";
minArgs = 1;
maxArgs = 1;
labels.add("fpc leave");

2
src/main/java/com/fpghoti/fpchatx/command/commands/MessageCommand.java
View File

@ -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 + "<player> <message>";
minArgs = 2;
maxArgs = 100000;
labels.add("msg");

2
src/main/java/com/fpghoti/fpchatx/command/commands/ReplyCommand.java
View File

@ -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 + "<message>";
minArgs = 1;
maxArgs = 10000;
labels.add("reply");

2
src/main/java/com/fpghoti/fpchatx/command/commands/RevokeBadgeCommand.java
View File

@ -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 + "<player> <badge number>";
minArgs = 2;
maxArgs = 2;
labels.add("fpc revokebadge");

2
src/main/java/com/fpghoti/fpchatx/command/commands/ShoutCommand.java
View File

@ -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 + "<message>";
minArgs = 0;
maxArgs = 100000;
labels.add("fpc shout");

2
src/main/java/com/fpghoti/fpchatx/command/commands/ShoutToggleCommand.java
View File

@ -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");

2
src/main/java/com/fpghoti/fpchatx/command/commands/SpyCommand.java
View File

@ -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");

2
src/main/java/com/fpghoti/fpchatx/command/commands/TalkCommand.java
View File

@ -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 + "<channel> [message]";
minArgs = 1;
maxArgs = 100000;
labels.add("fpc talk");

2
src/main/java/com/fpghoti/fpchatx/command/commands/UnHushCommand.java
View File

@ -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 + "<player>";
minArgs = 1;
maxArgs = 1;
labels.add("fpc unhush");

2
src/main/java/com/fpghoti/fpchatx/command/commands/UnignoreCommand.java
View File

@ -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 + "<player>";
minArgs = 1;
maxArgs = 1;
labels.add("fpc unignore");

2
src/main/java/com/fpghoti/fpchatx/command/commands/WhoCommand.java
View File

@ -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");