Brandon/FastAsyncWorldedit
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Include flags in documentation

Browse Source
This commit is contained in:
Jesse Boyd 2017-04-19 05:39:46 +10:00
parent 87341ab4fe
commit 31e64eaaf4
No known key found for this signature in database
GPG Key ID: 59F1DE6293AF6E1F
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
core/src/main/java/com/boydti/fawe/util/DocumentationPrinter.java
View File

@ -75,7 +75,13 @@ public final class DocumentationPrinter {
"Command documentation will be consistent with what is available ingame"); "Command documentation will be consistent with what is available ingame");
stream.println(); stream.println();
stream.println(); stream.println();
stream.print("To view this information ingame use `//help`"); stream.print("To view this information ingame use `//help [category|command]`\n");
stream.print("## Command Syntax \n");
stream.print(" - `<arg>` - A required parameter \n");
stream.print(" - `[arg]` - An optional parameter \n");
stream.print(" - `<arg1|arg2>` - Multiple parameters options \n");
stream.print(" - `<arg=value>` - Default or suggested value \n");
stream.print(" - `-a` - A command flag e.g. `//<command> -a [flag-value]`");
stream.println(); stream.println();
stream.print("## See also\n"); stream.print("## See also\n");
stream.print(" - [Masks](https://github.com/boy0001/FastAsyncWorldedit/wiki/WorldEdit---FAWE-mask-list)\n"); stream.print(" - [Masks](https://github.com/boy0001/FastAsyncWorldedit/wiki/WorldEdit---FAWE-mask-list)\n");
@ -148,7 +154,7 @@ public final class DocumentationPrinter {
Command cmd = method.getAnnotation(Command.class); Command cmd = method.getAnnotation(Command.class);
String[] aliases = cmd.aliases(); String[] aliases = cmd.aliases();
String usage = prefix + aliases[0] + " " + cmd.usage(); String usage = prefix + aliases[0] + " " + cmd.usage();
if (cmd.anyFlags()) { if (!cmd.flags().isEmpty()) {
for (char c : cmd.flags().toCharArray()) { for (char c : cmd.flags().toCharArray()) {
usage += " [-" + c + "]"; usage += " [-" + c + "]";
} }
@ -159,7 +165,8 @@ public final class DocumentationPrinter {
CommandPermissions perms = method.getAnnotation(CommandPermissions.class); CommandPermissions perms = method.getAnnotation(CommandPermissions.class);
stream.append("**Perm**: `" + StringMan.join(perms.value(), "`, `") + "` \n"); stream.append("**Perm**: `" + StringMan.join(perms.value(), "`, `") + "` \n");
} }
stream.append("**Desc**: " + cmd.desc().trim().replaceAll("\n", "<br />") + " \n"); String help = cmd.help() == null || cmd.help().isEmpty() ? cmd.desc() : cmd.help();
stream.append("**Desc**: " + help.trim().replaceAll("\n", "<br />") + " \n");
if (method.isAnnotationPresent(NestedCommand.class)) { if (method.isAnnotationPresent(NestedCommand.class)) {
NestedCommand nested = NestedCommand nested =