Skip to content

Commit f9af082

Browse files
authored
Merge pull request #213 from kah-seng/update-docs
Update inconsistencies in UG and DG
2 parents d72fbe4 + badcdca commit f9af082

3 files changed

Lines changed: 16 additions & 9 deletions

File tree

docs/DeveloperGuide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Given below is a quick overview of main components and how they interact with ea
3939

4040
**Main components of the architecture**
4141

42-
**`Main`** (consisting of classes [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java)) is in charge of the app launch and shut down.
42+
**`Main`** (consisting of classes [`Main`](https://github.com/AY2526S2-CS2103-T11-2/tp/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/AY2526S2-CS2103-T11-2/tp/tree/master/src/main/java/seedu/address/MainApp.java)) is in charge of the app launch and shut down.
4343
* At app launch, it initializes the other components in the correct sequence, and connects them up with each other.
4444
* At shut down, it shuts down the other components and invokes cleanup methods where necessary.
4545

@@ -71,13 +71,13 @@ The sections below give more details of each component.
7171

7272
### UI component
7373

74-
The **API** of this component is specified in [`Ui.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java)
74+
The **API** of this component is specified in [`Ui.java`](https://github.com/AY2526S2-CS2103-T11-2/tp/tree/master/src/main/java/seedu/address/ui/Ui.java)
7575

7676
<puml src="diagrams/UiClassDiagram.puml" alt="Structure of the UI Component"/>
7777

7878
The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `PersonListPanel`, `StatusBarFooter` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between classes that represent parts of the visible GUI.
7979

80-
The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/resources/view/MainWindow.fxml)
80+
The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/AY2526S2-CS2103-T11-2/tp/tree/master/src/main/java/seedu/address/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/AY2526S2-CS2103-T11-2/tp/tree/master/src/main/resources/view/MainWindow.fxml)
8181

8282
The `UI` component,
8383

@@ -88,7 +88,7 @@ The `UI` component,
8888

8989
### Logic component
9090

91-
**API** : [`Logic.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/logic/Logic.java)
91+
**API** : [`Logic.java`](https://github.com/AY2526S2-CS2103-T11-2/tp/tree/master/src/main/java/seedu/address/logic/Logic.java)
9292

9393
Here's a (partial) class diagram of the `Logic` component:
9494

@@ -120,7 +120,7 @@ How the parsing works:
120120
* All `XYZCommandParser` classes (e.g., `AddCommandParser`, `DeleteCommandParser`, ...) inherit from the `Parser` interface so that they can be treated similarly where possible e.g, during testing.
121121

122122
### Model component
123-
**API** : [`Model.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/model/Model.java)
123+
**API** : [`Model.java`](https://github.com/AY2526S2-CS2103-T11-2/tp/tree/master/src/main/java/seedu/address/model/Model.java)
124124

125125
<puml src="diagrams/ModelClassDiagram.puml" width="450" />
126126

@@ -143,7 +143,7 @@ The `Model` component,
143143

144144
### Storage component
145145

146-
**API** : [`Storage.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/storage/Storage.java)
146+
**API** : [`Storage.java`](https://github.com/AY2526S2-CS2103-T11-2/tp/tree/master/src/main/java/seedu/address/storage/Storage.java)
147147

148148
<puml src="diagrams/StorageClassDiagram.puml" width="550" />
149149

docs/diagrams/BetterModelClassDiagram.puml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,11 @@ Person *--> Name
1818
Person *--> Phone
1919
Person *--> Email
2020
Person *--> Address
21+
Person *--> Remark
22+
Person *--> DietaryRemark
23+
DietaryRemark -up-|> Remark
24+
Person *--> ClassRemark
25+
ClassRemark -up-|> Remark
26+
Person *--> BehaviorRemark
27+
BehaviorRemark -up-|> Remark
2128
@enduml

docs/diagrams/ModelClassDiagram.puml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ Person *--> Address
4444
Person *--> Age
4545
Person *--> Remark
4646
Person *--> DietaryRemark
47-
DietaryRemark .up.|> Remark
47+
DietaryRemark -up-|> Remark
4848
Person *--> ClassRemark
49-
ClassRemark .up.|> Remark
49+
ClassRemark -up-|> Remark
5050
Person *--> BehaviorRemark
51-
BehaviorRemark .up.|> Remark
51+
BehaviorRemark -up-|> Remark
5252
Person *--> "*" Tag
5353

5454
Person -[hidden]up--> I

0 commit comments

Comments
 (0)