feat: Add aliases in message usage strings

AY2324S1-CS2103T-T10-2 · Oct 27, 2023 · 9139eb1 · 9139eb1
1 parent 2282e2f
commit 9139eb1
Show file tree

Hide file tree

Showing 13 changed files with 26 additions and 14 deletions.
diff --git a/src/main/java/seedu/address/logic/commands/AddPersonCommand.java b/src/main/java/seedu/address/logic/commands/AddPersonCommand.java
@@ -21,7 +21,8 @@ public class AddPersonCommand extends Command {
     public static final String COMMAND_WORD = "addPerson";
     public static final String SHORTENED_COMMAND_WORD = "ap";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a person to the address book. "
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " (alias: " + SHORTENED_COMMAND_WORD + ")"
+            + ": Adds a person to the address book.\n"
             + "Parameters: "
             + PREFIX_NAME + "NAME "
             + PREFIX_PHONE + "PHONE "

diff --git a/src/main/java/seedu/address/logic/commands/AddTaskCommand.java b/src/main/java/seedu/address/logic/commands/AddTaskCommand.java
@@ -19,7 +19,8 @@ public class AddTaskCommand extends Command {
     public static final String COMMAND_WORD = "addTask";
     public static final String SHORTENED_COMMAND_WORD = "at";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a task to the address book. "
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " (alias: " + SHORTENED_COMMAND_WORD + ")"
+            + ": Adds a task to the address book.\n"
             + "Parameters: "
             + PREFIX_TASK_TITLE + "TITLE "
             + PREFIX_TASK_NOTE + "NOTE "

diff --git a/src/main/java/seedu/address/logic/commands/DeletePersonCommand.java b/src/main/java/seedu/address/logic/commands/DeletePersonCommand.java
@@ -19,7 +19,7 @@ public class DeletePersonCommand extends Command {
     public static final String COMMAND_WORD = "deletePerson";
     public static final String SHORTENED_COMMAND_WORD = "dp";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " (alias: " + SHORTENED_COMMAND_WORD + ")"
             + ": Deletes the person identified by the index number used in the displayed person list.\n"
             + "Parameters: INDEX (must be a positive integer)\n"
             + "Example: " + COMMAND_WORD + " 1";

diff --git a/src/main/java/seedu/address/logic/commands/DeleteTaskCommand.java b/src/main/java/seedu/address/logic/commands/DeleteTaskCommand.java
@@ -19,7 +19,7 @@ public class DeleteTaskCommand extends Command {
     public static final String COMMAND_WORD = "deleteTask";
     public static final String SHORTENED_COMMAND_WORD = "dt";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " (alias: " + SHORTENED_COMMAND_WORD + ")"
             + ": Deletes the task identified by the index number used in the displayed task list.\n"
             + "Parameters: INDEX (must be a positive integer)\n"
             + "Example: " + COMMAND_WORD + " 1";

diff --git a/src/main/java/seedu/address/logic/commands/EditPersonCommand.java b/src/main/java/seedu/address/logic/commands/EditPersonCommand.java
@@ -36,7 +36,8 @@ public class EditPersonCommand extends Command {
     public static final String COMMAND_WORD = "editPerson";
     public static final String SHORTENED_COMMAND_WORD = "ep";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Edits the details of the person identified "
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " (alias: " + SHORTENED_COMMAND_WORD + ")"
+            + ": Edits the details of the person identified "
             + "by the index number used in the displayed person list. "
             + "Existing values will be overwritten by the input values.\n"
             + "Parameters: INDEX (must be a positive integer) "
@@ -140,7 +141,8 @@ public static class EditPersonDescriptor {
         private Address address;
         private Set<Tag> tags;
 
-        public EditPersonDescriptor() {}
+        public EditPersonDescriptor() {
+        }
 
         /**
          * Copy constructor.

diff --git a/src/main/java/seedu/address/logic/commands/EditTaskCommand.java b/src/main/java/seedu/address/logic/commands/EditTaskCommand.java
@@ -33,7 +33,8 @@ public class EditTaskCommand extends Command {
     public static final String COMMAND_WORD = "editTask";
     public static final String SHORTENED_COMMAND_WORD = "et";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Edits the details of the task identified "
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " (alias: " + SHORTENED_COMMAND_WORD + ")"
+            + ": Edits the details of the task identified "
             + "by the index number used in the displayed task list. "
             + "Existing values will be overwritten by the input values.\n"
             + "Parameters: INDEX (must be a positive integer) "

diff --git a/src/main/java/seedu/address/logic/commands/FindDoneCommand.java b/src/main/java/seedu/address/logic/commands/FindDoneCommand.java
@@ -15,7 +15,8 @@ public class FindDoneCommand extends Command {
     public static final String COMMAND_WORD = "findDone";
     public static final String SHORTENED_COMMAND_WORD = "fd";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all tasks whose status is marked as "
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " (alias: " + SHORTENED_COMMAND_WORD + ")"
+            + ": Finds all tasks whose status is marked as "
             + "done and displays them as a list with index numbers.\n"
             + "Example: " + COMMAND_WORD;
 

diff --git a/src/main/java/seedu/address/logic/commands/FindNotDoneCommand.java b/src/main/java/seedu/address/logic/commands/FindNotDoneCommand.java
@@ -15,7 +15,8 @@ public class FindNotDoneCommand extends Command {
     public static final String COMMAND_WORD = "findNotDone";
     public static final String SHORTENED_COMMAND_WORD = "fnd";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all tasks whose status is marked as "
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " (alias: " + SHORTENED_COMMAND_WORD + ")"
+            + ": Finds all tasks whose status is marked as "
             + "not done and displays them as a list with index numbers.\n"
             + "Example: " + COMMAND_WORD;
 

diff --git a/src/main/java/seedu/address/logic/commands/FindPersonCommand.java b/src/main/java/seedu/address/logic/commands/FindPersonCommand.java
@@ -16,7 +16,8 @@ public class FindPersonCommand extends Command {
     public static final String COMMAND_WORD = "findPerson";
     public static final String SHORTENED_COMMAND_WORD = "fp";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all persons whose names contain any of "
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " (alias: " + SHORTENED_COMMAND_WORD + ")"
+            + ": Finds all persons whose names contain any of "
             + "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n"
             + "Parameters: KEYWORD [MORE_KEYWORDS]...\n"
             + "Example: " + COMMAND_WORD + " alice bob charlie";

diff --git a/src/main/java/seedu/address/logic/commands/FindTagCommand.java b/src/main/java/seedu/address/logic/commands/FindTagCommand.java
@@ -16,7 +16,8 @@ public class FindTagCommand extends Command {
     public static final String COMMAND_WORD = "findTag";
     public static final String SHORTENED_COMMAND_WORD = "ftag";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all persons and tasks whose tag contain any of "
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " (alias: " + SHORTENED_COMMAND_WORD + ")"
+            + ": Finds all persons and tasks whose tag contain any of "
             + "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n"
             + "Parameters: KEYWORD [MORE_KEYWORDS]...\n"
             + "Example: " + COMMAND_WORD + " agenda";

diff --git a/src/main/java/seedu/address/logic/commands/FindTaskCommand.java b/src/main/java/seedu/address/logic/commands/FindTaskCommand.java
@@ -16,7 +16,8 @@ public class FindTaskCommand extends Command {
     public static final String COMMAND_WORD = "findTask";
     public static final String SHORTENED_COMMAND_WORD = "ft";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all tasks whose title or note contain any of "
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " (alias: " + SHORTENED_COMMAND_WORD + ")"
+            + ": Finds all tasks whose title or note contain any of "
             + "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n"
             + "Parameters: KEYWORD [MORE_KEYWORDS]...\n"
             + "Example: " + COMMAND_WORD + " agenda budget";

diff --git a/src/main/java/seedu/address/logic/commands/MarkTaskCommand.java b/src/main/java/seedu/address/logic/commands/MarkTaskCommand.java
@@ -20,7 +20,8 @@ public class MarkTaskCommand extends Command {
     public static final String COMMAND_WORD = "markTask";
     public static final String SHORTENED_COMMAND_WORD = "mt";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Mark status as done for the task specified "
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " (alias: " + SHORTENED_COMMAND_WORD + ")"
+            + ": Mark status as done for the task specified "
             + "by the index number used in the displayed task list.\n"
             + "Parameters: INDEX (must be a positive integer)\n"
             + "Example: " + COMMAND_WORD + " 1 ";

diff --git a/src/main/java/seedu/address/logic/commands/UnmarkTaskCommand.java b/src/main/java/seedu/address/logic/commands/UnmarkTaskCommand.java
@@ -20,7 +20,8 @@ public class UnmarkTaskCommand extends Command {
     public static final String COMMAND_WORD = "unmarkTask";
     public static final String SHORTENED_COMMAND_WORD = "ut";
 
-    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Mark status as not done for the task specified "
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " (alias: " + SHORTENED_COMMAND_WORD + ")"
+            + ": Mark status as not done for the task specified "
             + "by the index number used in the displayed task list.\n"
             + "Parameters: INDEX (must be a positive integer)\n"
             + "Example: " + COMMAND_WORD + " 1 ";