From ad4e043bb17b0e5d37281af6f99b26dc5c91be81 Mon Sep 17 00:00:00 2001 From: Ye Yint Paing Oo Date: Wed, 16 Feb 2022 20:09:51 +0800 Subject: [PATCH] Amend java doc --- src/main/java/duke/Duke.java | 2 +- src/main/java/duke/List.java | 9 ++++----- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/src/main/java/duke/Duke.java b/src/main/java/duke/Duke.java index 5ace2791e4..c4ccaa2cf1 100644 --- a/src/main/java/duke/Duke.java +++ b/src/main/java/duke/Duke.java @@ -15,7 +15,7 @@ public class Duke { private final Ui ui; /** - * Create a chatterbot. + * Constructs a chatterbot. * @param filePath The file's storage path. */ public Duke(String filePath) { diff --git a/src/main/java/duke/List.java b/src/main/java/duke/List.java index 319da7dfa0..44cd736ad2 100644 --- a/src/main/java/duke/List.java +++ b/src/main/java/duke/List.java @@ -85,7 +85,7 @@ public void add(TaskType taskType, String description, LocalDateTime timing) { * Deletes a task from the list and returns it. * * @param index Index of the task in the list. - * @return Returns the task deleted + * @return Returns the task deleted. * @throws ListException If the index is out of bound. */ public Task delete(int index) throws ListException { @@ -100,9 +100,8 @@ public Task delete(int index) throws ListException { public Task getLast() { return tasks.get(tasks.size() - 1); } - /** - * Find a set of tasks that matches the description. + * Finds a set of tasks that matches the description. * * @param findDescription Description of the tasks to find. * @return Returns a list of the tasks found. @@ -118,8 +117,8 @@ public List findTask(String findDescription) { return new List(findTaskList); } /** - * Sort the tasks in the task list by their task type. - * Also sorts deadline tasks and event tasks by their local date time. + * Sorts the tasks in the task list by their task type + * and sorts deadline tasks and event tasks by their local date time. */ public void sort() { Collections.sort(this.getArrayList());