Update some comments

CS2103AUG2016-W11-C2 · Nov 6, 2016 · 0ae69cd · 0ae69cd
1 parent 493d642
commit 0ae69cd
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 2 deletions.
diff --git a/src/main/java/seedu/agendum/commons/events/ui/ShowHelpRequestEvent.java b/src/main/java/seedu/agendum/commons/events/ui/ShowHelpRequestEvent.java
@@ -2,6 +2,7 @@
 
 import seedu.agendum.commons.events.BaseEvent;
 
+//@@author A0148031R
 /**
  * An event requesting to view the help page.
  */

diff --git a/src/main/java/seedu/agendum/ui/CommandBox.java b/src/main/java/seedu/agendum/ui/CommandBox.java
@@ -29,6 +29,10 @@
 import java.util.logging.Logger;
 
 //@@author A0148031R
+/**
+ * Controller for the command box field
+ *
+ */
 public class CommandBox extends UiPart {
     private final Logger logger = LogsCenter.getLogger(CommandBox.class);
     private static final String FXML = "CommandBox.fxml";
@@ -118,6 +122,9 @@ private void handleCommandInputChanged() {
         logger.info(RESULT_FEEDBACK + mostRecentResult.feedbackToUser);
     }
 
+    /**
+     * Post meesage in the message place holder under the command box
+     */
     private void postMessage(String message) {
         this.messagePlaceHolder.getChildren().clear();
         raise(new CloseHelpWindowRequestEvent());

diff --git a/src/main/java/seedu/agendum/ui/CompletedTasksPanel.java b/src/main/java/seedu/agendum/ui/CompletedTasksPanel.java
@@ -46,6 +46,10 @@ private void configure() {
         completedTasksListView.addEventFilter(MouseEvent.MOUSE_PRESSED, Event::consume);
     }
 
+    /**
+     * Scrolls to the newly updated task and highlight for several seconds. If
+     * there are multiple tasks updated, previous highlight will not be cleared.
+     */
     public void scrollTo(Task task, boolean hasMultipleTasks) {
         Platform.runLater(() -> {
 

diff --git a/src/main/java/seedu/agendum/ui/FloatingTasksPanel.java b/src/main/java/seedu/agendum/ui/FloatingTasksPanel.java
@@ -46,6 +46,10 @@ private void configure() {
         floatingTasksListView.addEventFilter(MouseEvent.MOUSE_PRESSED, Event::consume);
     }
 
+    /**
+     * Scrolls to the newly updated task and highlight for several seconds. If
+     * there are multiple tasks updated, previous highlight will not be cleared.
+     */
     public void scrollTo(Task task, boolean hasMultipleTasks) {
         Platform.runLater(() -> {
 
@@ -83,7 +87,6 @@ protected void updateItem(ReadOnlyTask task, boolean empty) {
                 setText(null);
             } else {
                 setGraphic(TaskCard.load(task, mainTaskList.indexOf(task) + 1).getLayout());
-//                scrollTo();
             }
         }
     }

diff --git a/src/main/java/seedu/agendum/ui/TasksPanel.java b/src/main/java/seedu/agendum/ui/TasksPanel.java
@@ -10,7 +10,7 @@
 
 //@@author A0148031R
 /**
- * Panel contains the list of tasks
+ * Panel that contains the list of tasks
  */
 public abstract class TasksPanel extends UiPart{
     private AnchorPane panel;

diff --git a/src/main/java/seedu/agendum/ui/UpcomingTasksPanel.java b/src/main/java/seedu/agendum/ui/UpcomingTasksPanel.java
@@ -47,6 +47,10 @@ private void configure() {
         upcomingTasksListView.addEventFilter(MouseEvent.MOUSE_PRESSED, Event::consume);
     }
 
+    /**
+     * Scrolls to the newly updated task and highlight for several seconds. If
+     * there are multiple tasks updated, previous highlight will not be cleared.
+     */
     public void scrollTo(Task task, boolean hasMultipleTasks) {
         Platform.runLater(() -> {