Merge pull request #170 from ErnTekTeoh/dg

added javadocs

src/main/java/modulo/logic/commands/AddDeadlineCommand.java

@@ -85,6 +85,15 @@ public boolean get_isRepeated() {
         return this.isRepeated;
     }
 
+    /**
+     * Returns the result after execution of AddDeadlineCommand
+     *
+     * Deadline will be added to a specified parentEvent, or the current focused event if parentEvent isn't specified
+     *
+     * @param model Model of modulo
+     * @return CommandResult containing info regarding execution of the command
+     * @throws CommandException If certain prerequisites are unmet
+     */
     @Override
     public CommandResult execute(Model model) throws CommandException {
         requireNonNull(model);

src/main/java/modulo/logic/commands/ClearCommand.java

@@ -15,6 +15,12 @@ public class ClearCommand extends Command {
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Clears all data from Modulo.\n"
             + "Example: " + COMMAND_WORD;
 
+    /**
+     * Returns the result after execution of ClearCommand
+     *
+     * @param model Model of modulo
+     * @return CommandResult containing info regarding execution of the command
+     */
     @Override
     public CommandResult execute(Model model) {
         requireNonNull(model);

src/main/java/modulo/logic/commands/ExitCommand.java

@@ -13,6 +13,12 @@ public class ExitCommand extends Command {
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Exits Modulo.\n"
             + "Example: " + COMMAND_WORD;
 
+    /**
+     * Returns the result after execution of ExitCommand
+     *
+     * @param model Model of modulo
+     * @return CommandResult containing info regarding execution of the command
+     */
     @Override
     public CommandResult execute(Model model) {
         return new CommandResult(MESSAGE_EXIT_ACKNOWLEDGEMENT, false, true, false, false, null, null);

src/main/java/modulo/logic/commands/ExportCommand.java

@@ -43,6 +43,13 @@ public ExportCommand(Path exportDirectory) {
         this.exportDirectory = exportDirectory;
     }
 
+    /**
+     * Returns the result after execution of ExportCommand
+     *
+     * @param model Model of modulo
+     * @return CommandResult containing info regarding execution of the command
+     * @throws CommandException When system fails to write to file
+     */
     @Override
     public CommandResult execute(Model model) throws CommandException {
 

src/main/java/modulo/logic/commands/FindCommand.java

@@ -28,7 +28,12 @@ public FindCommand(NameContainsKeywordsPredicate predicate) {
         this.predicate = predicate;
     }
 
-
+    /**
+     * Returns the result after execution of FindCommand
+     *
+     * @param model Model of modulo
+     * @return CommandResult containing info regarding execution of the command
+     */
     @Override
     public CommandResult execute(Model model) {
         requireNonNull(model);

src/main/java/modulo/logic/commands/HelpCommand.java

@@ -14,6 +14,12 @@ public class HelpCommand extends Command {
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Shows program usage instructions.\n"
             + "Example: " + COMMAND_WORD;
 
+    /**
+     * Returns the result after execution of HelpCommand
+     *
+     * @param model Model of modulo
+     * @return CommandResult containing info on where to seek help
+     */
     @Override
     public CommandResult execute(Model model) {
         return new CommandResult(MESSAGE_SHOWING_HELP, true, false, false, false, null, null);

src/main/java/modulo/logic/commands/ListCommand.java

@@ -31,6 +31,12 @@ public ListCommand(DisplayableType displayableType) {
         this.displayableType = displayableType;
     }
 
+    /**
+     * Returns the result after execution of ListCommand
+     *
+     * @param model Model of modulo
+     * @return CommandResult containing info regarding execution of the command
+     */
     @Override
     public CommandResult execute(Model model) {
         requireNonNull(model);

src/main/java/modulo/logic/commands/ViewCommand.java

@@ -34,6 +34,13 @@ public ViewCommand(Index index) {
         this.index = index;
     }
 
+    /**
+     * Returns the result after execution of ViewCommand
+     *
+     * @param model Model of modulo
+     * @return CommandResult containing info regarding execution of the command
+     * @throws CommandException When index specified is invalid
+     */
     @Override
     public CommandResult execute(Model model) throws CommandException {
         requireNonNull(model);