Skip to content

Commit

Permalink
Merge pull request #163 from jylee-git/v1.4-Update-Documentation
Browse files Browse the repository at this point in the history
V1.4: Fixed discrepancies in DeveloperGuide and UserGuide
  • Loading branch information
Hafizuddin-github committed Nov 12, 2018
2 parents 512a038 + 9507dce commit 030e811
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 14 deletions.
24 changes: 19 additions & 5 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -941,6 +941,7 @@ Do take a look at <<Design-Storage>> before attempting to modify the `Storage` c
** See this https://github.com/se-edu/addressbook-level4/pull/594[PR] for the full solution.
****

[discrete]
==== `Session` component

*Scenario:* You are in charge of `session`, whereby it is used to manage users logging in/out. Currently, there is a
Expand Down Expand Up @@ -1643,6 +1644,17 @@ Use case resumes to step 1.
+
Use case ends.

*Extensions*

* 2a. User logged in but is not holding a priority level of "I.T. UNIT".
** 2a1. AddressBook shows an error message.
+
Use case ends.
* 2b. User is not logged in
** 2b1. AddressBook shows an error message.
+
Use case ends.

[appendix]
== Non Functional Requirements

Expand Down Expand Up @@ -1672,7 +1684,7 @@ These instructions only provide a starting point for testers to work on; testers
====
The following prerequisites apply to *ALL* test cases: - +
. The following test cases assume a *default slate* when the app is first launched or reset, *without any prior
. The following test cases assume a *default state* when the app is first launched or reset, *without any prior
modifications to the employees list and its' corresponding accounts*. Modify your test case according to whatever
changes that were made prior to executing each individual test cases.
. The following test cases assume that the employee list is *neither sorted nor filtered* prior to executing the
Expand Down Expand Up @@ -1702,7 +1714,7 @@ The following prerequisites apply to *ALL* test cases: - +
... Login NRIC has to be registered in the application, either through the sample data or added manually by an administrator.
... You are *not logged in* prior to testing this function.
.. Test case: `login ic/S1234567E pwd/Password` +
Expected: Status message box states that you are logged in successfully, with your name, and your shcedule (if any).
Expected: Status message box states that you are logged in successfully, with your name, and your schedule (if any).
Status bar will now show that you are logged in with the corresponding name of the user who logged in.
.. Test case: `login ic/S12345678 pwd/Password` +
Expected: Not logged in. Format of NRIC is incorrect and Status message box shows the NRIC constraints. Status bar remains unchanged.
Expand Down Expand Up @@ -1742,8 +1754,8 @@ The following prerequisites apply to *ALL* test cases: - +
==== Editing personal particulars of the person who is logged in
[NOTE]
====
Refer to <<UserGuide.adoc#editing-a-person-code-edit-code,EditCommand section of the User Guide>> for the list of
editable parameters.
Refer to <<UserGuide.adoc#editing-personal-particulars-code-edit-code,EditCommand section of the User Guide>> for the
list of editable parameters.
====
. Edits the editable particulars of the person who is logged in.
.. Prerequisites: User must be logged in to the application.
Expand Down Expand Up @@ -1778,7 +1790,9 @@ Expected: No employee is added. The NRIC of `Carol Crowe` is the same as `Charlo

. Deleting an employee while all employees are listed.

.. Prerequisites: List all employees using the `list` command. Multiple employees in the list.
.. Prerequisites: - +
... List all employees using the `list` command. Multiple employees in the list.
... User must be logged in as an administrator.
.. Test case: `delete 1` +
Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated.
.. Test case: `delete 0` +
Expand Down
21 changes: 13 additions & 8 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Logs out of the application, allowing for other users to log in again.

//end::jylee-git_login[]

==== Editing an employee : `edit`
==== Editing personal particulars : `edit`

Edits the existing particulars of the logged in user. +
Format : `edit [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]...` +
Expand Down Expand Up @@ -158,7 +158,7 @@ This command will NOT be able to edit the following:
Examples:

* `edit p/91234567 e/johndoe@example.com` +
Sets the logged in employee's details to the aforementioned email and phone number, and also clears tags if any. +
Sets the logged in employee's details to the aforementioned email and phone number. +
* `edit t/friend t/lecturer n/John Doe` +
Sets the logged in employee's details to the name of John Doe; clears all tag and sets the two aforementioned tags. +

Expand All @@ -180,7 +180,7 @@ Format: `add n/NAME ic/NRIC pwd/PASSWORD p/PHONE_NUMBER e/EMAIL d/DEPARTMENT a/A
====
* An employee can have any number of tags (including 0)
* Priority level will be set to BASIC if left empty
* A recently added employee have no schedule allocated
* A recently added employee will have no schedule allocated
* More than 2 decimal places for working rate is acceptable
====

Expand Down Expand Up @@ -709,7 +709,8 @@ image::checkedOut.PNG[width="700"]
====
This operation requires user to be logged in with a privilege level of `I.T. Unit` to perform.
====
Resets the application into a default slate, by deleting data/AddressBook.xml and data/leave.xml. The application will also close upon
Resets the application into a default state, by deleting data/AddressBook.xml and data/leave.xml. The application will
also close upon
deleting the two files.

Refer to the <<defaultcontacts, List of Default Contacts>> upon app reset on the contacts available.
Expand Down Expand Up @@ -738,10 +739,12 @@ There is no need to save manually.
• *<<Login to the application: `login`, Login>>*: `login ic/NRIC pwd/PASSWORD`
• *<<Checks the login status of the application: `checkloginstatus`, Check login status>>*: `checkloginstatus`
• *<<Logout of the application: `logout`, Logout>>*: `logout`
• *<<Editing an employee : `edit`, Edit particulars>>*: `edit [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]...`
• *<<Editing personal particulars : `edit`, Edit personal particulars>>*: `edit [n/NAME] [p/PHONE] [e/EMAIL]
[a/ADDRESS] [t/TAG]...`

=== Employee Management Database
• *<<Adding an employee: `add`, Add employee>>*: `add n/NAME ic/NRIC pwd/PASSWORD p/PHONE NUMBER e/EMAIL d/DEPARTMENT a/ADDRESS wr/WORKING_RATE [plvl/PRIORITY_LEVEL] [t/TAGS]...`
• *<<Adding an employee: `add`, Add employee>>*: `add n/NAME ic/NRIC pwd/PASSWORD p/PHONE_NUMBER e/EMAIL d/DEPARTMENT
a/ADDRESS wr/WORKING_RATE [plvl/PRIORITY_LEVEL] [t/TAG]...`
• *<<Deleting an employee : `delete`, Deleting employee>>*: `delete INDEX`
• *<<Change priority level of employee: `setplvl`, Set priority level of an employee>>*: `setplvl INDEX plvl/PRIORITY_LEVEL`
• *<<Change the department of an employee : `setdepartment`, Change department of an employee>>*: `setdepartment INDEX d/DEPARTMENT`
Expand Down Expand Up @@ -892,7 +895,8 @@ Department names should start with a name, and ends with 'Management'.
|
- Edit your own particulars +
- Apply for leave +
- Check in/out to/from work for their own
- Check in/out to/from work for their own +
- Set and view your own schedule

|MANAGER (2)
|
Expand All @@ -916,6 +920,7 @@ Department names should start with a name, and ends with 'Management'.
- All privileges of a MANAGER Priority level +
- Add and delete employees from the AddressBook +
- Set the priority level of all employees +
- Set Department of all employees
- Set Department of all employees +
- Set and view other employee's schedules
|===
//end::jylee-git_appendixB[]
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/MainApp.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
*/
public class MainApp extends Application {

public static final Version VERSION = new Version(3, 1, 10, true);
public static final Version VERSION = new Version(4, 0, 0, true);

private static final Logger logger = LogsCenter.getLogger(MainApp.class);

Expand Down

0 comments on commit 030e811

Please sign in to comment.