Skip to content

Commit

Permalink
Merge branch 'master' into miljyy-documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
miljyy authored Nov 13, 2023
2 parents ec80f87 + 3efaa88 commit cfeed4e
Show file tree
Hide file tree
Showing 6 changed files with 309 additions and 192 deletions.
381 changes: 197 additions & 184 deletions docs/DeveloperGuide.md

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions docs/diagrams/OvertimeActivityDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
@startuml
'https://plantuml.com/activity-diagram-beta

start
:User inputs overtime command;

if () then ([else])
:Display error message;
else ([valid command])
if () then ([else])
:Display error message;
else ([valid ID])
if () then ([else])
:Display error message;
else ([valid operation])
if () then ([else])
:Display error message;
else ([valid amount])
:Update employee's overtime hours;
:Display overtime success message;
endif
endif

@enduml
72 changes: 72 additions & 0 deletions docs/diagrams/OvertimeSequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
@startuml
!include style.puml

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
participant ":OvertimeCommandParser" as OvertimeCommandParser LOGIC_COLOR
participant "r:OvertimeCommand" as OvertimeCommand LOGIC_COLOR
participant ":CommandResult" as CommandResult LOGIC_COLOR
end box

box Model MODEL_COLOR_T1
participant ":Model" as Model MODEL_COLOR
end box
[-> LogicManager : execute("overtime id/EID1234-5678 o/inc a/2")
activate LogicManager

LogicManager -> AddressBookParser : parseCommand("overtime id/EID1234-5678 o/inc a/2")
activate AddressBookParser

create OvertimeCommandParser
AddressBookParser -> OvertimeCommandParser
activate OvertimeCommandParser

OvertimeCommandParser --> AddressBookParser
deactivate OvertimeCommandParser

AddressBookParser -> OvertimeCommandParser : parse("overtime id/EID1234-5678 o/inc a/2")
activate OvertimeCommandParser

create OvertimeCommand
OvertimeCommandParser -> OvertimeCommand
activate OvertimeCommand

OvertimeCommand --> OvertimeCommandParser : r
deactivate OvertimeCommand

OvertimeCommandParser --> AddressBookParser : r
deactivate OvertimeCommandParser

OvertimeCommandParser -[hidden]-> AddressBookParser
destroy OvertimeCommandParser

AddressBookParser --> LogicManager : r
deactivate AddressBookParser

LogicManager -> OvertimeCommand : execute()
activate OvertimeCommand

OvertimeCommand -> Model : setEmployee(employeeToUpdate, updatedEmployee)
activate Model

Model --> OvertimeCommand

OvertimeCommand -> Model : updateFilteredEmployeeList()

Model --> OvertimeCommand
deactivate Model

create CommandResult
OvertimeCommand -> CommandResult
activate CommandResult

CommandResult --> OvertimeCommand
deactivate CommandResult

OvertimeCommand --> LogicManager : result
deactivate OvertimeCommand

[<--LogicManager
deactivate LogicManager
@enduml
Binary file added docs/images/OvertimeActivityDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/OvertimeSequenceDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 16 additions & 8 deletions docs/team/jasonray168.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,21 @@ title: Jason Ray's Project Portfolio Page

### Project: HouR

HouR is a desktop HR management application used for managing and organising personnel data. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about [number] kLoC.
HouR is a desktop HR management application used for managing and organising personnel data. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 9 kLoC.

Given below are my contributions to the project.

* **New Attribute**: [OvertimeHours]
* What it represents: It keeps track of the number of overtime hours taken by an employee.
* Justification: Users will need to keep track of employee overtime hours to make changes their bonus salary and performance measures.

* **New Feature**: [Sort]
* What it does: It sorts the list of all employees based on a field and an order.
* Justification: Users will want to check for employee with the highest salary, the highest overtime hours taken, etc.
* Highlights: A big problem encountered during the implementation of this feature is that
* Highlights: A big problem encountered during the implementation of this feature is that
the list editing technique used in find feature does not work with sorting. Therefore, I was able to make this feature work
by editing the original employee list in UniqueEmployeeList.

* **New Feature**: [DeleteLeave]
* What it does: It deletes a leave from the list of leaves an employee has taken.
* Justification: Users might have to remove an allocated employee leave because of a mis-input, which will need a delete feature for the leave
Expand All @@ -27,15 +29,21 @@ Given below are my contributions to the project.

* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=JasonRay168&breakdown=true)

* **Project management**: Reviewing and approving pull requests on GitHub, assign bug issues to my account on GitHub.
* **Project management**:
* Reviewing and approving pull requests on GitHub
* Assign bug issues on GitHub.

* **Enhancements to existing features**:
* Added Overtime hours attribute to Employee class (Pull request [#116](https://github.com/AY2324S1-CS2103T-W12-1/tp/pull/116))

* **Documentation**:
* User Guide: Add guides for sort, add leave, and delete leave features.
* User Guide: Added guides for sort, add leave, and delete leave features.
* Developer Guide:
* Add implementation details for sort and delete leave features.
* Add instructions for manual testing for sort and delete leave features.
* Add details for planned enhancements.
* Added implementation details for sort and delete leave features.
* Added instructions for manual testing for sort and delete leave features.
* Added details for planned enhancements.
* Added details for use cases.

* **Community**:

* **Tools**: Java, JavaFX, IntelliJ, Git
* **Tools**: Java, JavaFX, IntelliJ, GitHub CLI, GitHub, PlantUML

0 comments on commit cfeed4e

Please sign in to comment.