Skip to content

Commit

Permalink
Merge pull request #186 from Vavinan/developer-guide
Browse files Browse the repository at this point in the history
Update the DG
  • Loading branch information
ShyamKrishna33 committed Apr 15, 2024
2 parents 47c856b + 0b24e22 commit b8428a9
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 9 deletions.
4 changes: 3 additions & 1 deletion docs/diagrams/RemoveAccounrSequenceDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ deactivate TL
AM -> AM: removeAccount(accountNumber)
AM -> UI: printDeleteAccountMessage(removedAccount, transactionsRemoved)
activate UI
UI --> User: Display removed account message
UI --> AM: Display removed account message
AM --> User: Confirmation message

deactivate UI
@enduml
3 changes: 2 additions & 1 deletion docs/diagrams/addAccountDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ deactivate P
AM -> AM: addAccount(parsedData[0], parsedData[1])
AM -> UI: printAddAccountMessage(newAccount)
activate UI
UI --> User: Display added account message
UI --> AM: Display added account message
AM --> User : Confirmation message
deactivate UI
@enduml
3 changes: 2 additions & 1 deletion docs/diagrams/addTransaction.puml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ deactivate P
TM -> TM: addTransaction(transaction)
TM -> UI: printAddMessage(transaction, account.balance)
activate UI
UI --> User: Display added transaction message
UI --> TM : Display added transaction message
TM --> User: Confirmation message
deactivate UI
@enduml
23 changes: 17 additions & 6 deletions docs/diagrams/processList.puml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ alt 1: All Transactions
TM -> TM: printTransactions()
TM -> UI: printTransactions()
activate UI
UI --> User: Display all transactions
UI --> TM: Display all transactions
UI --> User: Confirmation message
deactivate UI
else 2: Past Week Transactions
TM -> LD: now()
Expand All @@ -32,7 +33,9 @@ else 2: Past Week Transactions
TM -> TM: getPastTransactions(startDate)
TM -> UI: printPastTransactions(transactions, "week")
activate UI
UI --> User: Display past week transactions
UI --> TM: Display past week transactions
TM --> User: Confirmation message

deactivate UI
else 3: Past Month Transactions
TM -> LD: now()
Expand All @@ -41,7 +44,9 @@ else 3: Past Month Transactions
TM -> TM: getPastTransactions(startDate)
TM -> UI: printPastTransactions(transactions, "month")
activate UI
UI --> User: Display past month transactions
UI --> TM: Display past month transactions
TM --> User: Confirmation message

deactivate UI
else 4: Custom Date Transactions
TM -> UI: getStartDate()
Expand All @@ -56,7 +61,9 @@ else 4: Custom Date Transactions
TM -> TM: getCustomDateTransactions(startDate, endDate)
TM -> UI: printCustomDateTransactions(transactions)
activate UI
UI --> User: Display custom date transactions
UI --> TM: Display custom date transactions
TM --> User: Confirmation message

deactivate UI
else 5: Account Transactions
TM -> UI: printAccountList(accounts)
Expand All @@ -74,7 +81,9 @@ else 5: Account Transactions
TM -> TM: getAccountTransactions(transactions, accountNumber)
TM -> UI: printAccountTransactions(accountTransactions, accountName, accountNumber)
activate UI
UI ---> User: Display account transactions
UI ---> TM: Display account transactions
TM ---> User: Confirmation message

deactivate UI
else 6: Category Transactions
TM -> UI: listCategories()
Expand All @@ -90,7 +99,9 @@ else 6: Category Transactions
TM -> TM: getCategoryTransactions(transactions, categorySelected)
TM -> UI: printCategoryTransactions(categoryTransactions, categoryName)
activate UI
UI --> User: Display category transactions
UI --> TM: Display category transactions
TM --> User: Confirmation message

deactivate UI
end
@enduml
Binary file modified docs/images/RemoveAccounrSequenceDiagram.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 modified docs/images/addAccountDiagram.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 modified docs/images/addTransactionDiagram.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 modified docs/images/processList.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b8428a9

Please sign in to comment.