Skip to content

Commit

Permalink
Amend java doc
Browse files Browse the repository at this point in the history
  • Loading branch information
paing-oo committed Feb 16, 2022
1 parent a9cd20e commit ad4e043
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
2 changes: 1 addition & 1 deletion src/main/java/duke/Duke.java
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
9 changes: 4 additions & 5 deletions src/main/java/duke/List.java
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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.
Expand All @@ -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());
Expand Down

0 comments on commit ad4e043

Please sign in to comment.