From 409de122e75ba3fe044de9a64eba4553e58a4810 Mon Sep 17 00:00:00 2001 From: yorklim Date: Wed, 27 Mar 2024 17:11:12 +0800 Subject: [PATCH] Fix checkstyle issues --- docs/DeveloperGuide.md | 4 ++-- docs/UserGuide.md | 20 ++++++++++---------- docs/diagrams/AddPolicyObjectDiagram.puml | 2 +- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 0de27cf957b..d6673171639 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -163,9 +163,9 @@ The add policy feature allows users to add a policy to a client. The policy is s #### Implementation -The add policy command mechanism is facilitated by the `AddPolicyCommandParser` class which is created by the `AddressBookParser` . +The add policy command mechanism is facilitated by the `AddPolicyCommandParser` class which is created by the `AddressBookParser`. -The `AddPolicyCommandParser` class is responsible for parsing the user input and creating an `AddPolicyCommand` object. +The `AddPolicyCommandParser` class is responsible for parsing the user input and creating an `AddPolicyCommand` object. The `AddPolicyCommandParser#parse()` overrides `Parser#parse()` in the `Parser` interface. - `AddPolicyCommandParser#parse()` - Parses the input arguments by storing the prefixes of it respective values in a `ArgumentMultimap` object, and creates a new `AddPolicyCommand` object with the parsed policy name and policy ID. diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3aba6af7111..4c7b04d5354 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -62,12 +62,12 @@ You might encounter these call-outs while reading through the guide, which conta -**Tip:** Tip call-outs like this contain helpful pointers for using ClientCare! +**Tip:** Tip call-outs like this contain helpful pointers for using ClientCare! -**Note:** Information call-outs like this contain information about ClientCare you should take note of! +**Note:** Information call-outs like this contain information about ClientCare you should take note of! @@ -80,7 +80,7 @@ You might encounter these call-outs while reading through the guide, which conta ## Introduction -Made for insurance agents and clients, by insurance agents and clients. +Made for insurance agents and clients, by insurance agents and clients. ClientCare is the easiest way to manage your clients and schedules, all in one place. Powerful features and intuitive design, all packaged into one neat desktop app. ClientCare is supported on all major platforms (Windows, macOS). @@ -88,16 +88,16 @@ major platforms (Windows, macOS). #### Let ClientCare assist you in... -1. [**Managing your clients**](#client-related-commands) +1. [**Managing your clients**](#client-related-commands) ClientCare lets you store, edit and delete your client's information. Keep all your clients' details in one place and save time! -2. [**Planning your schedule**](#schedule-related-commands) +2. [**Planning your schedule**](#schedule-related-commands) Meeting clients are part of the job. Not sure when to meet your next client? ClientCare reminds you of clients that you may have missed out! -3. [**Keeping track of policies**](#policy-related-commands) +3. [**Keeping track of policies**](#policy-related-commands) Too many policies from different companies? Why not track all of them in one place! ClientCare allows you to attach policies to all your clients, regardless of companies and product type. @@ -238,7 +238,7 @@ Alternatively, [Command Summary](#command-summary) has all of them under one pag
## Quick Tutorial -Excited to play around with ClientCare? +Excited to play around with ClientCare? Let’s run you through some simple commands to get you warmed up before you dive right into ClientCare’s full feature list! @@ -263,7 +263,7 @@ Type the following into the Command Input: ![addclient](images/ug/addclient.png =600x) -2. We have now added James Wee to our Client List! ClientCare shows a success message in the Feedback Display too. +2. We have now added James Wee to our Client List! ClientCare shows a success message in the Feedback Display too. @@ -450,7 +450,7 @@ Examples: -**Tip:** You can use `find` to more easily find the client you want for commands that require a client `INDEX`! +**Tip:** You can use `find` to more easily find the client you want for commands that require a client `INDEX`!
@@ -476,7 +476,7 @@ ClientCare offers the following commands to help you manage your schedule: * [Updating last met: `met`](#updating-last-met-met) * [Scheduling an appointment: `schedule`](#scheduling-appointments-schedule) * [Marking an appointment: `mark`](#marking-appointments-mark) - +

diff --git a/docs/diagrams/AddPolicyObjectDiagram.puml b/docs/diagrams/AddPolicyObjectDiagram.puml index 1439e39a5a0..5a6eea3ec63 100644 --- a/docs/diagrams/AddPolicyObjectDiagram.puml +++ b/docs/diagrams/AddPolicyObjectDiagram.puml @@ -23,4 +23,4 @@ AddPolicyCommand --> Model AddPolicyCommand -right-> CommandResult : outputs Model --> Person2 : Removes Model --> Person1 : Updates -@enduml \ No newline at end of file +@enduml