Skip to content

Commit 01ac110

Browse files
chore: update DOxygen class header for P1 Todo to be more in depth
1 parent 45abda7 commit 01ac110

1 file changed

Lines changed: 25 additions & 7 deletions

File tree

src/main/java/Creative Project 1 Todo/TodoListManager.java

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
11
import java.io.*;
22
import java.util.*;
33

4-
/// Gives CRUD operations for a todos Arraylist of type string.
5-
///
6-
/// Prompts the user in a sentinel while loop for their input and acts on their
7-
/// input if valid.
4+
/**
5+
* Command-line TODO list application.
6+
*
7+
* <p>
8+
* Provides basic CRUD style operations on an in-memory list of TODO items
9+
* (where each item is a {@link String}). The program runs an interactive loop
10+
* that repeatedly prompts the user to choose an action:
11+
* </p>
12+
*
13+
* <ul>
14+
* <li><b>Add<b> a new TODO (optionally at a specific position)</li>
15+
* <li><b>Mark</b> one TODO (or a range of TODOs) as done by removing
16+
* it/them</li>
17+
* <li><b>Load</b> TODOs from a text file (one item per line)</li>
18+
* <li><b>Save</b> TODOs to a text file (one item per line)</li>
19+
* <li><b>Quit</b></li>
20+
* </ul>
21+
*
22+
* <p>
23+
* File format: plain text, one TODO per line.
24+
* </p>
25+
*/
826
public class TodoListManager {
927
public static final boolean EXTENSION_FLAG = true;
1028

@@ -17,8 +35,8 @@ public static void main(String[] args) throws FileNotFoundException {
1735

1836
while (!quit) {
1937
System.out.println("What would you like to do?");
20-
System.out.print(
21-
"(A)dd TODO, (M)ark TODO as done, (L)oad TODOs," + "(S)ave TODOs, (Q)uit? ");
38+
System.out
39+
.print("(A)dd TODO, (M)ark TODO as done, (L)oad TODOs, (S)ave TODOs, (Q)uit? ");
2240
String input = console.nextLine();
2341

2442
if (input.equalsIgnoreCase("A")) {
@@ -155,7 +173,7 @@ public static void loadItems(Scanner console, List<String> todos) throws FileNot
155173
}
156174

157175
/**
158-
* @brief Prints `todos` items to a user specified file
176+
* Prints `todos` items to a user specified file
159177
*
160178
* @param console:
161179
* Scanner object to parse user input

0 commit comments

Comments
 (0)