Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CS2113-T13-1]-Dkenobi-UpdateDG #376

Merged
merged 8 commits into from
Nov 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.

Expand All @@ -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
Expand Down
Binary file modified docs/images/classDiagram/ArchDukeLogger_ClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/sequenceDiagram/ViewReminders_Sequence.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.