You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
3.**e(fx)clipse** plugin for Eclipse (Follow the instructions given in [this page](http://www.eclipse.org/efxclipse/install.html#for-the-ambitious) from Step 2 onwards.)
60
59
4.**Buildship Gradle Integration** plugin from the Eclipse Marketplace
61
60
5.**Checkstyle Plug-in** plugin from the Eclipse Marketplace or its [official website](http://eclipse-cs.sourceforge.net/#!/install)
62
61
@@ -97,7 +96,7 @@ In order to better contribute, you should:
97
96
98
97
**Problem: Eclipse reports some required libraries missing**
99
98
* Reason: Required libraries may not have been downloaded during the project import.
100
-
* Solution: [Run tests using Gardle](UsingGradle.md) once (to refresh the libraries).
99
+
* Solution: [Run tests using Gradle](UsingGradle.md) once (to refresh the libraries).
101
100
102
101
**[⬆ back to top](#user-content-table)**
103
102
@@ -112,8 +111,8 @@ The **_Architecture Diagram_** given above explains the high-level design of the
112
111
Given below is a quick overview of each component.
113
112
114
113
`Main` has only one class called [`MainApp`](../src/main/java/seedu/geekeep/MainApp.java). It is responsible for:
115
-
*At app launch: initializing the components in the correct sequence, and connecting them up with each other.
116
-
*At shut down: shutting down the components and invoking cleanup method where necessary.
114
+
*App Launching: initialize the components in the correct sequence, and connect them up with each other.
115
+
*Shutting Down: shut down the components and invoke cleanup method where necessary.
117
116
118
117
[**`Commons`**](#common-classes) represents a collection of classes used by multiple other components.
119
118
Two of those classes play important roles at the architecture level.
@@ -132,9 +131,7 @@ Each of the four components:
132
131
* Exposes its functionality using a `{Component Name}Manager` class.
133
132
134
133
For example, the `Logic` component (see the class diagram given below) defines its API in the `Logic.java`
135
-
interface and exposes its functionality using the `LogicManager.java` class.<br>
1.`Logic` uses the `Parser` class to parse the user command.
190
-
2. This results in a `Command` object which is executed by the `LogicManager`.
191
-
3. The command execution can affect the `Model` (e.g. adding a task) and/or raise events.
192
-
4. The result of the command execution is encapsulated as a `CommandResult` object which is passed back to the `Ui`.
186
+
The `Logic` component:
187
+
188
+
* Parses the user command using each command's respective `Parser`.
189
+
* Executes a `Command` object based on the command and user input.
190
+
* Encapsulates the result, a feedback `string` in a `CommandResult` object.
191
+
192
+
For example, the following is what happens when the API `execute("delete 1")` is called:
193
+
194
+
1.`LogicManager` parses the user command using the `Parser` class.
195
+
1.`Parser` subsequently uses `DeleteCommandParser` to parse the argument `1`.
196
+
1. This results in a `DeleteCommand` object which is returned to `LogicManager`.
197
+
1.`LogicManager` executes the `DeleteCommand` object.
198
+
1. The command execution can affect the `Model` (e.g. adding a task) and/or raise events.
199
+
1. The result of the command execution is encapsulated as a `CommandResult` object which is passed back to the `Ui`.
193
200
194
201
Given below is the Sequence Diagram for interactions within the `Logic` component for the `execute("delete 1")`
195
202
API call.<br>
@@ -248,7 +255,7 @@ and logging destinations.
248
255
*`SEVERE` : Critical problem detected which may possibly cause the termination of the application.
249
256
*`WARNING` : Can continue, but with caution.
250
257
*`INFO` : Information showing the noteworthy actions by the App.
251
-
*`FINE` : Details that is not usually noteworthy but may be useful in debugging
258
+
*`FINE` : Details that are not noteworthy but may be useful in debugging
252
259
e.g. print the actual list instead of just its size.
253
260
254
261
<h3id="user-content-config">Configuration</h3>
@@ -363,7 +370,7 @@ Here are the steps to convert the project documentation files to PDF format:
363
370
1. Make sure you have set up GitHub Pages as described in [UsingGithubPages.md](UsingGithubPages.md#setting-up).
364
371
1. Using Chrome, go to the [GitHub Pages version](UsingGithubPages.md#viewing-the-project-site) of the
365
372
documentation file. <br>
366
-
e.g. For [UserGuide.md](UserGuide.md), the URL will be `https://<your-username-or-organization-name>.github.io/addressbook-level4/docs/UserGuide.html`.
373
+
e.g. For [UserGuide.md](UserGuide.md), the URL will be `https://<your-username-or-organization-name>.github.io/geekeep/docs/UserGuide.html`.
367
374
1. Click on the `Print` option in Chrome's menu.
368
375
1. Set the destination to `Save as PDF`, then click `Save` to save a copy of the file in PDF format. <br>
369
376
For best results, use the settings indicated in the screenshot below. <br>
0 commit comments