Skip to content

Commit

Permalink
Tidy JavaDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Pluiexo authored and Pluiexo committed Feb 22, 2024
1 parent 6ec69dd commit 83fb4ff
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 13 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# plato.Plato project template
# Plato project template

This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
This is a project template for a greenfield Java project. It's inspired after the Java mascot _Duke_. Given below are instructions on how to use it.

## Setting up in Intellij

Expand All @@ -13,12 +13,13 @@ Prerequisites: JDK 11, update Intellij to the most recent version.
1. If there are any further prompts, accept the defaults.
1. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).<br>
In the same dialog, set the **Project language level** field to the `SDK default` option.
3. After that, locate the `src/main/java/plato.Plato.java` file, right-click it, and choose `Run plato.Plato.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see something like the below as the output:
3. After that, locate the `src/main/java/plato/Launcher.java` file, right-click it, and choose `Run plato.Launcher.main()` (if the code editor is showing compile errors, try restarting the IDE). If the setup is correct, you should see a GUI window.
```
Hello from
____ _
| _ \ _ _| | _____
| | | | | | | |/ / _ \
| |_| | |_| | < __/
|____/ \__,_|_|\_\___|
```
.______ __ ___ .___________. ______
| _ \ | | / \ | | / __ \
| |_) | | | / ^ \ `---| |----`| | | |
| ___/ | | / /_\ \ | | | | | |
| | | `----./ _____ \ | | | `--' |
| _| |_______/__/ \__\ |__| \______/
```
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Examples:

* `event cs2103 planning /from 1800 24/02/24 /to 1900 27/02/24`

* `event midterm study session /from 01:00pm 28-02-24 /to 02:00pm 30-02-24`
* `event midterm study session /from 01:00pm 28-02-24 /to 02:00pm 01-03-24`

Expected outcome:
```
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/plato/parser/Parser.java
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ public static String[] parse(String command, TaskManager manager) throws PlatoEx


/**
* @return Whether plato should close the chat-bot.
* Checks if should close the bot.
* @return Whether plato should close the chat bot.
*/
public static boolean isExit() {
return isDead;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/plato/task/Actions.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package plato.task;

/**
* Actions indicate teh type of task
* Actions indicate the type of task.
*/
public enum Actions {
TODO, DEADLINE, EVENT
Expand Down
1 change: 0 additions & 1 deletion src/main/java/plato/task/Todo.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package plato.task;


/**
* Create a todo class that only has a name.
*/
Expand Down

0 comments on commit 83fb4ff

Please sign in to comment.