diff --git a/docs/diagrams/ArchitectureSequenceDiagram.puml b/docs/diagrams/ArchitectureSequenceDiagram.puml index ef81d18c3..48b6cc433 100644 --- a/docs/diagrams/ArchitectureSequenceDiagram.puml +++ b/docs/diagrams/ArchitectureSequenceDiagram.puml @@ -1,5 +1,6 @@ @startuml !include style.puml +skinparam ArrowFontStyle plain Actor User as user USER_COLOR Participant ":UI" as ui UI_COLOR diff --git a/docs/diagrams/CommitActivityDiagram.puml b/docs/diagrams/CommitActivityDiagram.puml index 6a6b23a00..8c0892d6a 100644 --- a/docs/diagrams/CommitActivityDiagram.puml +++ b/docs/diagrams/CommitActivityDiagram.puml @@ -1,4 +1,7 @@ @startuml +skin rose +skinparam ActivityFontSize 15 +skinparam ArrowFontSize 12 start :User executes command; diff --git a/docs/diagrams/ComponentManagers.puml b/docs/diagrams/ComponentManagers.puml index 5e907dc11..564dd1ae3 100644 --- a/docs/diagrams/ComponentManagers.puml +++ b/docs/diagrams/ComponentManagers.puml @@ -4,17 +4,17 @@ skinparam arrowThickness 1.1 skinparam arrowColor LOGIC_COLOR_T4 skinparam classBackgroundColor LOGIC_COLOR -package Logic { +package Logic as LogicPackage { Class "<>\nLogic" as Logic Class LogicManager } -package Model{ +package Model as ModelPackage { Class "<>\nModel" as Model Class ModelManager } -package Storage{ +package Storage as StoragePackage { Class "<>\nStorage" as Storage Class StorageManager } diff --git a/docs/diagrams/DeleteSequenceDiagram.puml b/docs/diagrams/DeleteSequenceDiagram.puml index 1dc2311b2..40ea6c9dc 100644 --- a/docs/diagrams/DeleteSequenceDiagram.puml +++ b/docs/diagrams/DeleteSequenceDiagram.puml @@ -1,5 +1,6 @@ @startuml !include style.puml +skinparam ArrowFontStyle plain box Logic LOGIC_COLOR_T1 participant ":LogicManager" as LogicManager LOGIC_COLOR diff --git a/docs/diagrams/LogicClassDiagram.puml b/docs/diagrams/LogicClassDiagram.puml index d4193173e..a57720890 100644 --- a/docs/diagrams/LogicClassDiagram.puml +++ b/docs/diagrams/LogicClassDiagram.puml @@ -4,7 +4,7 @@ skinparam arrowThickness 1.1 skinparam arrowColor LOGIC_COLOR_T4 skinparam classBackgroundColor LOGIC_COLOR -package Logic { +package Logic as LogicPackage { Class AddressBookParser Class XYZCommand @@ -16,11 +16,11 @@ Class "<>\nLogic" as Logic Class LogicManager } -package Model{ +package Model { Class HiddenModel #FFFFFF } -package Storage{ +package Storage { } Class HiddenOutside #FFFFFF diff --git a/docs/diagrams/ModelClassDiagram.puml b/docs/diagrams/ModelClassDiagram.puml index 443910897..0de567307 100644 --- a/docs/diagrams/ModelClassDiagram.puml +++ b/docs/diagrams/ModelClassDiagram.puml @@ -4,7 +4,7 @@ skinparam arrowThickness 1.1 skinparam arrowColor MODEL_COLOR skinparam classBackgroundColor MODEL_COLOR -Package Model <>{ +Package Model as ModelPackage <>{ Class "<>\nReadOnlyAddressBook" as ReadOnlyAddressBook Class "<>\nReadOnlyUserPrefs" as ReadOnlyUserPrefs Class "<>\nModel" as Model @@ -20,6 +20,7 @@ Class Name Class Phone Class Tag +Class I #FFFFFF } Class HiddenOutside #FFFFFF @@ -42,9 +43,12 @@ Person *--> Email Person *--> Address Person *--> "*" Tag +Person -[hidden]up--> I +UniquePersonList -[hidden]right-> I + Name -[hidden]right-> Phone Phone -[hidden]right-> Address Address -[hidden]right-> Email -ModelManager -->"~* filtered" Person +ModelManager --> "~* filtered" Person @enduml diff --git a/docs/diagrams/StorageClassDiagram.puml b/docs/diagrams/StorageClassDiagram.puml index 760305e0e..a821e0645 100644 --- a/docs/diagrams/StorageClassDiagram.puml +++ b/docs/diagrams/StorageClassDiagram.puml @@ -4,7 +4,7 @@ skinparam arrowThickness 1.1 skinparam arrowColor STORAGE_COLOR skinparam classBackgroundColor STORAGE_COLOR -package Storage{ +package Storage as StoragePackage { package "UserPrefs Storage" #F4F6F6{ Class "<>\nUserPrefsStorage" as UserPrefsStorage diff --git a/docs/diagrams/UndoRedoState0.puml b/docs/diagrams/UndoRedoState0.puml index 96e30744d..43a45903a 100644 --- a/docs/diagrams/UndoRedoState0.puml +++ b/docs/diagrams/UndoRedoState0.puml @@ -2,19 +2,20 @@ !include style.puml skinparam ClassFontColor #000000 skinparam ClassBorderColor #000000 +skinparam ClassBackgroundColor #FFFFAA title Initial state package States { - class State1 as "__ab0:AddressBook__" - class State2 as "__ab1:AddressBook__" - class State3 as "__ab2:AddressBook__" + class State1 as "ab0:AddressBook" + class State2 as "ab1:AddressBook" + class State3 as "ab2:AddressBook" } State1 -[hidden]right-> State2 State2 -[hidden]right-> State3 hide State2 hide State3 -class Pointer as "Current State" #FFFFF +class Pointer as "Current State" #FFFFFF Pointer -up-> State1 @end diff --git a/docs/diagrams/UndoRedoState1.puml b/docs/diagrams/UndoRedoState1.puml index 01fcb9b2b..5a41e9e16 100644 --- a/docs/diagrams/UndoRedoState1.puml +++ b/docs/diagrams/UndoRedoState1.puml @@ -2,13 +2,14 @@ !include style.puml skinparam ClassFontColor #000000 skinparam ClassBorderColor #000000 +skinparam ClassBackgroundColor #FFFFAA title After command "delete 5" package States <> { - class State1 as "__ab0:AddressBook__" - class State2 as "__ab1:AddressBook__" - class State3 as "__ab2:AddressBook__" + class State1 as "ab0:AddressBook" + class State2 as "ab1:AddressBook" + class State3 as "ab2:AddressBook" } State1 -[hidden]right-> State2 @@ -16,7 +17,7 @@ State2 -[hidden]right-> State3 hide State3 -class Pointer as "Current State" #FFFFF +class Pointer as "Current State" #FFFFFF Pointer -up-> State2 @end diff --git a/docs/diagrams/UndoRedoState2.puml b/docs/diagrams/UndoRedoState2.puml index bccc230a5..ad32fce1b 100644 --- a/docs/diagrams/UndoRedoState2.puml +++ b/docs/diagrams/UndoRedoState2.puml @@ -2,19 +2,20 @@ !include style.puml skinparam ClassFontColor #000000 skinparam ClassBorderColor #000000 +skinparam ClassBackgroundColor #FFFFAA title After command "add n/David" package States <> { - class State1 as "__ab0:AddressBook__" - class State2 as "__ab1:AddressBook__" - class State3 as "__ab2:AddressBook__" + class State1 as "ab0:AddressBook" + class State2 as "ab1:AddressBook" + class State3 as "ab2:AddressBook" } State1 -[hidden]right-> State2 State2 -[hidden]right-> State3 -class Pointer as "Current State" #FFFFF +class Pointer as "Current State" #FFFFFF Pointer -up-> State3 @end diff --git a/docs/diagrams/UndoRedoState3.puml b/docs/diagrams/UndoRedoState3.puml index ea29c9483..9187a6900 100644 --- a/docs/diagrams/UndoRedoState3.puml +++ b/docs/diagrams/UndoRedoState3.puml @@ -2,19 +2,20 @@ !include style.puml skinparam ClassFontColor #000000 skinparam ClassBorderColor #000000 +skinparam ClassBackgroundColor #FFFFAA title After command "undo" package States <> { - class State1 as "__ab0:AddressBook__" - class State2 as "__ab1:AddressBook__" - class State3 as "__ab2:AddressBook__" + class State1 as "ab0:AddressBook" + class State2 as "ab1:AddressBook" + class State3 as "ab2:AddressBook" } State1 -[hidden]right-> State2 State2 -[hidden]right-> State3 -class Pointer as "Current State" #FFFFF +class Pointer as "Current State" #FFFFFF Pointer -up-> State2 @end diff --git a/docs/diagrams/UndoRedoState4.puml b/docs/diagrams/UndoRedoState4.puml index 1b784cece..2bc631ffc 100644 --- a/docs/diagrams/UndoRedoState4.puml +++ b/docs/diagrams/UndoRedoState4.puml @@ -2,19 +2,20 @@ !include style.puml skinparam ClassFontColor #000000 skinparam ClassBorderColor #000000 +skinparam ClassBackgroundColor #FFFFAA title After command "list" package States <> { - class State1 as "__ab0:AddressBook__" - class State2 as "__ab1:AddressBook__" - class State3 as "__ab2:AddressBook__" + class State1 as "ab0:AddressBook" + class State2 as "ab1:AddressBook" + class State3 as "ab2:AddressBook" } State1 -[hidden]right-> State2 State2 -[hidden]right-> State3 -class Pointer as "Current State" #FFFFF +class Pointer as "Current State" #FFFFFF Pointer -up-> State2 @end diff --git a/docs/diagrams/UndoRedoState5.puml b/docs/diagrams/UndoRedoState5.puml index 88927be32..e77b04104 100644 --- a/docs/diagrams/UndoRedoState5.puml +++ b/docs/diagrams/UndoRedoState5.puml @@ -2,19 +2,20 @@ !include style.puml skinparam ClassFontColor #000000 skinparam ClassBorderColor #000000 +skinparam ClassBackgroundColor #FFFFAA title After command "clear" package States <> { - class State1 as "__ab0:AddressBook__" - class State2 as "__ab1:AddressBook__" - class State3 as "__ab3:AddressBook__" + class State1 as "ab0:AddressBook" + class State2 as "ab1:AddressBook" + class State3 as "ab3:AddressBook" } State1 -[hidden]right-> State2 State2 -[hidden]right-> State3 -class Pointer as "Current State" #FFFFF +class Pointer as "Current State" #FFFFFF Pointer -up-> State3 note right on link: State ab2 deleted. diff --git a/docs/diagrams/UndoSequenceDiagram.puml b/docs/diagrams/UndoSequenceDiagram.puml index 410aab4e4..87ff3e923 100644 --- a/docs/diagrams/UndoSequenceDiagram.puml +++ b/docs/diagrams/UndoSequenceDiagram.puml @@ -1,5 +1,6 @@ @startuml !include style.puml +skinparam ArrowFontStyle plain box Logic LOGIC_COLOR_T1 participant ":LogicManager" as LogicManager LOGIC_COLOR diff --git a/docs/diagrams/plantuml/AbeforeC.puml b/docs/diagrams/plantuml/AbeforeC.puml deleted file mode 100644 index b4c86d69e..000000000 --- a/docs/diagrams/plantuml/AbeforeC.puml +++ /dev/null @@ -1,11 +0,0 @@ -@startuml -!include ../style.puml - -Class A LOGIC_COLOR_T3 -Class B LOGIC_COLOR_T3 -Class C UI_COLOR_T3 -Class D UI_COLOR_T3 - -A --> B -C --> D -@enduml diff --git a/docs/diagrams/plantuml/AllDown.puml b/docs/diagrams/plantuml/AllDown.puml deleted file mode 100644 index 6eaf1c8bb..000000000 --- a/docs/diagrams/plantuml/AllDown.puml +++ /dev/null @@ -1,25 +0,0 @@ -@startuml -!include ../style.puml - -Class A LOGIC_COLOR_T3 -Class B LOGIC_COLOR_T3 -Class C LOGIC_COLOR_T3 -Class D LOGIC_COLOR_T3 - -Class 1 MODEL_COLOR_T3 -Class 2 MODEL_COLOR_T3 -Class 3 MODEL_COLOR_T3 -Class 4 MODEL_COLOR_T3 - -Class Z UI_COLOR_T3 - -A --> Z -B --> Z -C --> Z -D --> Z - -A --> 1 -B --> 2 -C --> 3 -D --> 4 -@enduml diff --git a/docs/diagrams/plantuml/ArrowLength.puml b/docs/diagrams/plantuml/ArrowLength.puml deleted file mode 100644 index 99c5abfe0..000000000 --- a/docs/diagrams/plantuml/ArrowLength.puml +++ /dev/null @@ -1,27 +0,0 @@ -@startuml -!include ../style.puml - -Package "Short\n->" { -Class A LOGIC_COLOR_T1 -Class B LOGIC_COLOR_T1 -A -> B -} - -Package "Long\n-->" { -Class C LOGIC_COLOR_T2 -Class D LOGIC_COLOR_T2 -C --> D -} - -Package "Longer\n--->" { -Class E LOGIC_COLOR_T3 -Class F LOGIC_COLOR_T3 -E ---> F -} - -Package "Even Longer\n---->" { -Class G LOGIC_COLOR_T4 -Class H LOGIC_COLOR_T4 -G ----> H -} -@enduml diff --git a/docs/diagrams/plantuml/CbeforeA.puml b/docs/diagrams/plantuml/CbeforeA.puml deleted file mode 100644 index 87dbca3f1..000000000 --- a/docs/diagrams/plantuml/CbeforeA.puml +++ /dev/null @@ -1,11 +0,0 @@ -@startuml -!include ../style.puml - -Class C UI_COLOR_T3 -Class A LOGIC_COLOR_T3 -Class B LOGIC_COLOR_T3 -Class D UI_COLOR_T3 - -A --> B -C --> D -@enduml diff --git a/docs/diagrams/plantuml/HiddenArrows.puml b/docs/diagrams/plantuml/HiddenArrows.puml deleted file mode 100644 index c17ef6e4f..000000000 --- a/docs/diagrams/plantuml/HiddenArrows.puml +++ /dev/null @@ -1,30 +0,0 @@ -@startuml -!include ../style.puml - -Class A LOGIC_COLOR_T3 -Class B LOGIC_COLOR_T3 -Class C LOGIC_COLOR_T3 -Class D LOGIC_COLOR_T3 - -Class 1 MODEL_COLOR_T3 -Class 2 MODEL_COLOR_T3 -Class 3 MODEL_COLOR_T3 -Class 4 MODEL_COLOR_T3 - -Class Z UI_COLOR_T3 - -A -up-> Z -B -up-> Z -C -up-> Z -D -up-> Z - -A --> 1 -B --> 2 -C --> 3 -D --> 4 - -'Force A B C D -A -right[hidden]- B -B -right[hidden]- C -C -right[hidden]- D -@enduml diff --git a/docs/diagrams/plantuml/PackagesAndConsistency.puml b/docs/diagrams/plantuml/PackagesAndConsistency.puml deleted file mode 100644 index 6364eb5de..000000000 --- a/docs/diagrams/plantuml/PackagesAndConsistency.puml +++ /dev/null @@ -1,14 +0,0 @@ -@startuml -!include ../style.puml - -package "Rule Of Thumb"{ - Class C UI_COLOR_T3 - Class D UI_COLOR_T3 - Class A LOGIC_COLOR_T3 - Class B LOGIC_COLOR_T3 - - A --> B - C --> D -} - -@enduml diff --git a/docs/diagrams/plantuml/UpAndDown.puml b/docs/diagrams/plantuml/UpAndDown.puml deleted file mode 100644 index e7a0313ad..000000000 --- a/docs/diagrams/plantuml/UpAndDown.puml +++ /dev/null @@ -1,29 +0,0 @@ -@startuml -!include ../style.puml - -Class A LOGIC_COLOR_T3 -Class B LOGIC_COLOR_T3 -Class C LOGIC_COLOR_T3 -Class D LOGIC_COLOR_T3 - -Class 1 MODEL_COLOR_T3 -Class 2 MODEL_COLOR_T3 -Class 3 MODEL_COLOR_T3 -Class 4 MODEL_COLOR_T3 - -Class Z UI_COLOR_T3 - -'default is down -A --> Z -'specify down -B -down-> Z -'shorthand for down -C -d-> Z -'arrow lengths take priority -D -down> Z - -A -up-> 1 -B -up-> 2 -C -up-> 3 -D -up-> 4 -@enduml diff --git a/docs/diagrams/style.puml b/docs/diagrams/style.puml index fad8b0ade..f7d7347ae 100644 --- a/docs/diagrams/style.puml +++ b/docs/diagrams/style.puml @@ -33,12 +33,15 @@ !define USER_COLOR #000000 -skinparam BackgroundColor #FFFFFFF - -skinparam Shadowing false +skinparam Package { + BackgroundColor #FFFFFF + BorderThickness 1 + FontSize 16 +} skinparam Class { FontColor #FFFFFF + FontSize 15 BorderThickness 1 BorderColor #FFFFFF StereotypeFontColor #FFFFFF @@ -64,6 +67,7 @@ skinparam Participant { Padding 20 } +skinparam ArrowFontStyle bold skinparam MinClassWidth 50 skinparam ParticipantPadding 10 skinparam Shadowing false diff --git a/docs/diagrams/tracing/LogicSequenceDiagram.puml b/docs/diagrams/tracing/LogicSequenceDiagram.puml index fdcbe1c0c..42bf46d3c 100644 --- a/docs/diagrams/tracing/LogicSequenceDiagram.puml +++ b/docs/diagrams/tracing/LogicSequenceDiagram.puml @@ -1,5 +1,6 @@ @startuml !include ../style.puml +skinparam ArrowFontStyle plain Participant ":LogicManager" as logic LOGIC_COLOR Participant ":AddressBookParser" as abp LOGIC_COLOR diff --git a/docs/images/ArchitectureDiagram.png b/docs/images/ArchitectureDiagram.png index 86c60246c..cd5406650 100644 Binary files a/docs/images/ArchitectureDiagram.png and b/docs/images/ArchitectureDiagram.png differ diff --git a/docs/images/ArchitectureSequenceDiagram.png b/docs/images/ArchitectureSequenceDiagram.png index 2f1346869..37ad06a28 100644 Binary files a/docs/images/ArchitectureSequenceDiagram.png and b/docs/images/ArchitectureSequenceDiagram.png differ diff --git a/docs/images/BetterModelClassDiagram.png b/docs/images/BetterModelClassDiagram.png index 94440f0ac..02a42e35e 100644 Binary files a/docs/images/BetterModelClassDiagram.png and b/docs/images/BetterModelClassDiagram.png differ diff --git a/docs/images/CommitActivityDiagram.png b/docs/images/CommitActivityDiagram.png index c08c13f5c..5b464126b 100644 Binary files a/docs/images/CommitActivityDiagram.png and b/docs/images/CommitActivityDiagram.png differ diff --git a/docs/images/ComponentManagers.png b/docs/images/ComponentManagers.png index b5764ff92..ae52a3571 100644 Binary files a/docs/images/ComponentManagers.png and b/docs/images/ComponentManagers.png differ diff --git a/docs/images/DeleteSequenceDiagram.png b/docs/images/DeleteSequenceDiagram.png index fa327b396..e186f7ba0 100644 Binary files a/docs/images/DeleteSequenceDiagram.png and b/docs/images/DeleteSequenceDiagram.png differ diff --git a/docs/images/LogicClassDiagram.png b/docs/images/LogicClassDiagram.png index 9e9ba9f79..e3b784310 100644 Binary files a/docs/images/LogicClassDiagram.png and b/docs/images/LogicClassDiagram.png differ diff --git a/docs/images/ModelClassDiagram.png b/docs/images/ModelClassDiagram.png index 04070af60..a19fb1b4a 100644 Binary files a/docs/images/ModelClassDiagram.png and b/docs/images/ModelClassDiagram.png differ diff --git a/docs/images/ParserClasses.png b/docs/images/ParserClasses.png index e7b4c8880..edfd1ff78 100644 Binary files a/docs/images/ParserClasses.png and b/docs/images/ParserClasses.png differ diff --git a/docs/images/StorageClassDiagram.png b/docs/images/StorageClassDiagram.png index 2533a5c1a..18fa4d0d5 100644 Binary files a/docs/images/StorageClassDiagram.png and b/docs/images/StorageClassDiagram.png differ diff --git a/docs/images/UiClassDiagram.png b/docs/images/UiClassDiagram.png index 785e04dba..11f06d686 100644 Binary files a/docs/images/UiClassDiagram.png and b/docs/images/UiClassDiagram.png differ diff --git a/docs/images/UndoRedoState0.png b/docs/images/UndoRedoState0.png index 8f7538cd8..c5f91b585 100644 Binary files a/docs/images/UndoRedoState0.png and b/docs/images/UndoRedoState0.png differ diff --git a/docs/images/UndoRedoState1.png b/docs/images/UndoRedoState1.png index df9908d09..2d3ad09c0 100644 Binary files a/docs/images/UndoRedoState1.png and b/docs/images/UndoRedoState1.png differ diff --git a/docs/images/UndoRedoState2.png b/docs/images/UndoRedoState2.png index 36519c101..20853694e 100644 Binary files a/docs/images/UndoRedoState2.png and b/docs/images/UndoRedoState2.png differ diff --git a/docs/images/UndoRedoState3.png b/docs/images/UndoRedoState3.png index 19959d017..1a9551b31 100644 Binary files a/docs/images/UndoRedoState3.png and b/docs/images/UndoRedoState3.png differ diff --git a/docs/images/UndoRedoState4.png b/docs/images/UndoRedoState4.png index 4c623e4f2..46dfae78c 100644 Binary files a/docs/images/UndoRedoState4.png and b/docs/images/UndoRedoState4.png differ diff --git a/docs/images/UndoRedoState5.png b/docs/images/UndoRedoState5.png index 84ad2afa6..f45889b5f 100644 Binary files a/docs/images/UndoRedoState5.png and b/docs/images/UndoRedoState5.png differ diff --git a/docs/images/UndoSequenceDiagram.png b/docs/images/UndoSequenceDiagram.png index 6addcd3a8..c7a7e6372 100644 Binary files a/docs/images/UndoSequenceDiagram.png and b/docs/images/UndoSequenceDiagram.png differ diff --git a/docs/images/tracing/LogicSequenceDiagram.png b/docs/images/tracing/LogicSequenceDiagram.png index c9b1f6cc2..25c8b66b9 100644 Binary files a/docs/images/tracing/LogicSequenceDiagram.png and b/docs/images/tracing/LogicSequenceDiagram.png differ