Merge pull request #336 from UncleGrandpa925/implement-additional-features-v1.4

Add some javadocs and move arePrefixPresent of AddCommands to ParserUtil

Author: UncleGrandpa925

src/main/java/trackitnus/logic/Logic.java

@@ -111,28 +111,28 @@ public interface Logic {
     /**
      * @param module The module to get index of
      * @return The index of the module in the list of all modules
-     * @throws CommandException
+     * @throws CommandException If an error occurs during execution
      */
     Index getModuleIndex(Module module) throws CommandException;
 
     /**
      * @param code The module code to get index of
      * @return The index of the module with the specified code in the list of all modules
-     * @throws CommandException
+     * @throws CommandException If an error occurs during execution
      */
     Index getModuleIndex(Code code) throws CommandException;
 
     /**
      * @param task The task to get index of.
      * @return The index of the task in list of all tasks.
-     * @throws CommandException
+     * @throws CommandException If an error occurs during execution
      */
     Index getTaskIndex(Task task) throws CommandException;
 
     /**
      * @param lesson The lesson to get index of.
      * @return The index of the lesson in list of all lessons.
-     * @throws CommandException
+     * @throws CommandException If an error occurs during execution
      */
     Index getLessonIndex(Lesson lesson) throws CommandException;
 

src/main/java/trackitnus/logic/LogicManager.java

@@ -95,8 +95,6 @@ public void clearAllList() {
         model.clearAllList();
     }
 
-    //--------------------------------START of V1.3's new functions--------------------------------
-
     @Override
     public ObservableList<Lesson> getDayUpcomingLessons(LocalDate date) {
         return model.getDayUpcomingLessons(date);
@@ -152,8 +150,6 @@ public Index getTaskIndex(Task task) throws CommandException {
         return model.getTaskIndex(task);
     }
 
-    //--------------------------------END of V1.3's new functions--------------------------------
-
     @Override
     public Path getTrackIterFilePath() {
         return model.getTrackIterFilePath();

src/main/java/trackitnus/logic/commands/CommandResult.java

@@ -62,8 +62,9 @@ public CommandResult(String feedbackToUser) {
 
     /**
      * Constructs a CommandResult to handle the event if a module is being edited
-     * @param feedbackToUser of module being edited
-     * @param editedModule the module it is being edited to
+     *
+     * @param feedbackToUser  of module being edited
+     * @param editedModule    the module it is being edited to
      * @param preEditedModule the module prior to being edited
      */
     public CommandResult(String feedbackToUser, Module editedModule, Module preEditedModule) {
@@ -72,8 +73,6 @@ public CommandResult(String feedbackToUser, Module editedModule, Module preEdite
 
     /**
      * Constructs a CommandResult to handle the event of a module being deleted
-     * @param feedbackToUser
-     * @param nameOfDeletedModule
      */
     public CommandResult(String feedbackToUser, String nameOfDeletedModule) {
         this(feedbackToUser, false, false, null, null, nameOfDeletedModule);

src/main/java/trackitnus/logic/commands/contact/DeleteContactCommand.java

@@ -26,6 +26,9 @@ public final class DeleteContactCommand extends Command {
 
     private final Index targetIndex;
 
+    /**
+     * Creates an DeleteContactCommand to delete the Contact with the specified Index
+     */
     public DeleteContactCommand(Index targetIndex) {
         this.targetIndex = targetIndex;
     }

src/main/java/trackitnus/logic/commands/lesson/DeleteLessonCommand.java

@@ -28,7 +28,7 @@ public final class DeleteLessonCommand extends Command {
     /**
      * Creates a DeleteLessonCommand to delete the specified {@code Lesson}
      *
-     * @param index
+     * @param index index of the lesson to delete in the current FilteredLessonList
      */
     public DeleteLessonCommand(Index index) {
         this.targetIndex = index;

src/main/java/trackitnus/logic/commands/lesson/EditLessonCommand.java

@@ -49,8 +49,8 @@ public final class EditLessonCommand extends Command {
     /**
      * Creates a EditLessonCommand to edit the specified {@code Lesson}
      *
-     * @param index
-     * @param editLessonDescriptor
+     * @param index                index of the lesson to edit in the current FilteredLessonList
+     * @param editLessonDescriptor the descriptor of the new lesson
      */
     public EditLessonCommand(Index index, EditLessonDescriptor editLessonDescriptor) {
         requireNonNull(index);
@@ -61,8 +61,8 @@ public EditLessonCommand(Index index, EditLessonDescriptor editLessonDescriptor)
     }
 
     /**
-     * Creates and returns a {@code Contact} with the details of {@code contactToEdit}
-     * edited with {@code editContactDescriptor}.
+     * Creates and returns a {@code Lesson} with the details of {@code lessonToEdit}
+     * edited with {@code editLessonDescriptor}.
      */
     private static Lesson createEditedLesson(Lesson lessonToEdit, EditLessonDescriptor editLessonDescriptor) {
         assert lessonToEdit != null;
@@ -126,8 +126,8 @@ public boolean equals(Object other) {
     }
 
     /**
-     * Stores the details to edit the contact with. Each non-empty field value will replace the
-     * corresponding field value of the contact.
+     * Stores the details to edit the lesson with. Each non-empty field value will replace the
+     * corresponding field value of the lesson.
      */
     public static final class EditLessonDescriptor {
         private Code code;

src/main/java/trackitnus/logic/commands/module/AddModuleCommand.java

@@ -27,7 +27,7 @@ public final class AddModuleCommand extends Command {
     private final Module toAdd;
 
     /**
-     * Creates an AddModule to add the specified {@code Module}
+     * Creates an AddModuleCommand to add the specified {@code Module}
      */
     public AddModuleCommand(Module module) {
         requireNonNull(module);

src/main/java/trackitnus/logic/commands/module/DeleteModuleCommand.java

@@ -27,6 +27,11 @@ public final class DeleteModuleCommand extends Command {
 
     private final Code targetCode;
 
+    /**
+     * Creates an DeleteModuleCommand to delete the Module
+     *
+     * @param targetCode the code of the module to delete
+     */
     public DeleteModuleCommand(Code targetCode) {
         this.targetCode = targetCode;
     }

src/main/java/trackitnus/logic/commands/module/EditModuleCommand.java

@@ -54,7 +54,7 @@ public EditModuleCommand(Code code, EditModuleDescriptor editModuleDescriptor) {
     }
 
     /**
-     * Creates and returns a {@code Model} with the details of {@code moduleToEdit}
+     * Creates and returns a {@code Module} with the details of {@code moduleToEdit}
      * edited with {@code editModuleDescriptor}.
      */
     private static Module createEditedModule(Module moduleToEdit,
@@ -99,6 +99,7 @@ public CommandResult execute(Model model) throws CommandException {
                 model.setLesson(lesson, updatedLesson);
             }
 
+            // edit all the related contacts
             List<Contact> contactsToEdit = new ArrayList<>(model.getModuleContacts(code));
             for (Contact contact : contactsToEdit) {
                 Contact updatedContact = contact.setTag(new Tag(code.toString()), new Tag(updatedCode.toString()));

src/main/java/trackitnus/logic/commands/task/AddTaskCommand.java

@@ -33,7 +33,7 @@ public final class AddTaskCommand extends Command {
     private final Task toAdd;
 
     /**
-     * Creates an AddContactCommand to add the specified {@code Contact}
+     * Creates an AddTaskCommand to add the specified {@code Task}
      */
     public AddTaskCommand(Task task) {
         requireNonNull(task);