Skip to content

Commit

Permalink
Merge pull request #414 from hingen/update-dg
Browse files Browse the repository at this point in the history
Fix model class diagram and update DG description
  • Loading branch information
jedidiahC authored Apr 9, 2023
2 parents b1172c0 + 7f9c4de commit 32b7583
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
10 changes: 6 additions & 4 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ title: Developer Guide

## **Le Tracker** Development ~

Welcome to the Developer's Guide for **Le Tracker**!
Welcome to the Developer Guide for **Le Tracker**!

This guide is intended to provide developers with a comprehensive overview of the **Le Tracker** system, as well as a detailed breakdown of the design pattern and features implementation required to build and customize the application.
This guide is intended to provide developers with an overview of the **Le Tracker** codebase, such as the [design](#design) of the codebase and the [implementation](#implementation) details of each feature as needed.

Whether you are an experienced developer looking to expand your skillset or a newcomer to the world of software development, this guide will provide you with the knowledge and tools you need to build a robust and efficient **Le Tracker** system.
This guide also contains the [requirements](#appendix-requirements) of **Le Tracker** to provide insights on the decision making process of the team and the goals of the application.

:information_source: **Le Tracker** GUI is built with *JavaFX* so you are highly recommended to develop in **Java**.
Before reading, it is recommended that developers read the [User Guide](https://ay2223s2-cs2103-f10-2.github.io/tp/UserGuide.html) first to gain an understanding of the features provided by **Le Tracker**.

:information_source: **Le Tracker** was developed with [**Java 11**](https://www.oracle.com/java/technologies/javase/jdk11-archive-downloads.html) and thus, it is recommended that developers use this version of Java.

---

Expand Down
4 changes: 2 additions & 2 deletions docs/diagrams/ModelClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Class "<<interface>>\nReadOnlyNavigation" as ReadOnlyNavigation
Class ModelManager
Class Tracker
Class UserPrefs
Class Navigation
Class "<<interface>>\nNavigation" as Navigation

Class UniqueModuleList
Class "<<interface>>\nReadOnlyModule" as ReadOnlyModule
Expand All @@ -36,7 +36,7 @@ Model .right.> ReadOnlyNavigation
ModelManager .up.|> Model
Tracker .up.|> ReadOnlyTracker
UserPrefs .up.|> ReadOnlyUserPrefs
Navigation .up.|> ReadOnlyNavigation
Navigation -up-|> ReadOnlyNavigation

ModelManager -left-> "1" Tracker
ModelManager -right-> "1" UserPrefs
Expand Down
Binary file modified docs/images/ModelClassDiagram.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 32b7583

Please sign in to comment.