diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc index 698c85c8e0..6a9d821478 100644 --- a/docs/DeveloperGuide.adoc +++ b/docs/DeveloperGuide.adoc @@ -330,7 +330,7 @@ differences, listed below: ArchDuke allows users to manage each individual project in the `ProjectRepository`. -===3.2 CRUD functionality for Members +=== 3.2 CRUD functionality for Members ==== Implementation CRUD Member functions are handled by Member, MemberList, MemberFactory, Project and ProjectInputController. @@ -752,14 +752,15 @@ logging every step that ArchDuke takes so that debugging will be easier. * The logging level is controlled by property name `rootLogger.level` in `log4j2.properties`. Currently the level is set to all. (Show all log level message) -* The `ArchDukeLogger` call by using ArchDukeLogger.logInfo(className, Message); function which will log the +* The `ArchDukeLogger` call by using `ArchDukeLogger.logInfo(className, Message);` function which will log the message according to the specified logging level method called. * Currently all the log messages are store in the log file located in the logs directory The `log4j2.properties` file in the resource folder is used configure the following: -* RootLogger level - The level root logger to be shown in the log file. Currently it is set to `all` +* RootLogger level - The level root logger to be shown in the log file. Currently it is set to `all` to view +all the logs level. * File Appender - The file direction and log file name. The log file can be found in the logs folder. @@ -769,6 +770,7 @@ The following shows the class diagram of ArchDukeLogger .Class diagram of ArchDuke logger image::images/classDiagram/ArchDukeLogger_ClassDiagram.png[] +*API* : link:{repoURL}/src/main/java/util/log/ArchDukeLogger.java[`ArchDukeLogger.java`] [NOTE] If any bugs or errors encountered during the testing, please do create an issue on this repo and upload the logs file located diff --git a/docs/images/classDiagram/ArchDukeLogger_ClassDiagram.png b/docs/images/classDiagram/ArchDukeLogger_ClassDiagram.png index 41ae44c268..87a6c180e0 100644 Binary files a/docs/images/classDiagram/ArchDukeLogger_ClassDiagram.png and b/docs/images/classDiagram/ArchDukeLogger_ClassDiagram.png differ diff --git a/docs/images/sequenceDiagram/ViewReminders_Sequence.png b/docs/images/sequenceDiagram/ViewReminders_Sequence.png index ce6b0ec0a4..b1dbe0fe33 100644 Binary files a/docs/images/sequenceDiagram/ViewReminders_Sequence.png and b/docs/images/sequenceDiagram/ViewReminders_Sequence.png differ