Merge pull request #136 from 3m0W33D/master

Update broken table and fix class diagram for DG
AY2122S1-CS2113T-T10-2 · Oct 27, 2021 · b7ab962 · b7ab962
2 parents 14a9f2d + b113681
commit b7ab962
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 16 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -132,6 +132,14 @@ Import the coding style xml file into your IntelliJ IDEA.
 
 ### 3.1 Architecture
 
+![](attachments/MainInit.png)  
+
+Initialization of all the classes required for Terminus class to run
+
+![](attachments/MainLogic.png)
+
+Main loop logic of Terminus
+
 ### 3.2 UI Component
 ![](attachments/UIClassDiagram.png)
 
@@ -466,7 +474,8 @@ Custom commands and Command Parsers should be easy for others to implement.
 | Approach | Pros | Cons|
 | ---  |---|---|
 | Single Command Parser with all Commands inherit from a single `Command` Class, a large switch statement to separate commands.| Easy to implement and `execute` function for each class has higher flexibility as they can have different arguments| When extending to multilevel workspace can be tedious to implement.|
-| Multiple Command Parsers each with its own set of commands, require separate managing. | Easy to create new workspace and add command specific the to workspace.| Implementation can be tedious and difficult to upgrade and manage.
+| Multiple Command Parsers each with its own set of commands, require separate managing. | Easy to create new workspace and add command specific the to workspace.| Implementation can be tedious and difficult to upgrade and manage. |  
+
 Eventually the team decide to go with the second implementation, as we require multi-level 
 workspaces and would like to create our own workspace for each feature. Aside from that the 
 `Command` provide common functionality that many commands need hence reducing repetition of code.

diff --git a/docs/attachments/Content.png b/docs/attachments/Content.png
diff --git a/docs/attachments/MainInit.png b/docs/attachments/MainInit.png
diff --git a/docs/attachments/MainLogic.png b/docs/attachments/MainLogic.png
diff --git a/docs/attachments/Module.png b/docs/attachments/Module.png
diff --git a/docs/uml/Content.puml b/docs/uml/Content.puml
@@ -1,4 +1,6 @@
 @startuml
+skinparam classAttributeIconSize 0
+hide circle
 
 Content <|-- Note
 Content <|-- Link
@@ -21,7 +23,8 @@ class ContentManager <T extends Content> {
   + setContent(contents: ArrayList<T> ): void
 }
 !endsub
-abstract class Content {
+
+abstract class "{abstract}\nContent" as Content{
   # name: String
   # data: String
 }

diff --git a/docs/uml/Module.puml b/docs/uml/Module.puml
@@ -1,20 +1,8 @@
 @startuml
 'https://plantuml.com/class-diagram
 
-
-
-'abstract class DGS
-'abstract AbstractCollection
-'interface List
-'interface Collection
-'
-'List <|-- AbstractList
-'Collection -- AbstractCollection
-'
-'Collection <|- List
-'AbstractCollection <|- AbstractList
-'AbstractList <|-- ArrayList
-
+skinparam classAttributeIconSize 0
+hide circle
 
 NusModule -> "1" ContentManager: noteManager
 NusModule -> "1" ContentManager: linkManager