Merge pull request #126 from alvinnzz/DG-planned-enhancements

Update planned enhancements for DG

docs/DeveloperGuide.md

@@ -30,7 +30,8 @@ title: Developer Guide
     * [Use Cases](#use-cases)
     * [Non-Functional Requirements](#non-functional-requirements)
     * [Glossary](#glossary)
-7. [Appendix: Instructions for manual testing](#appendix-instructions-for-manual-testing)
+7. [Appendix: Planned Enhancements](#appendix-planned-enhancements)
+8. [Appendix: Instructions for manual testing](#appendix-instructions-for-manual-testing)
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -828,6 +829,37 @@ ___
 * **Mainstream OS**: Windows, Linux, Unix, MacOS
 * **Private contact detail**: A contact detail that is not meant to be shared with others
 
+--------------------------------------------------------------------------------------------------------------------
+
+## **Appendix: Planned Enhancements**
+
+1. **Making Phone Number and Email Address Unique**
+
+    The current FriendFolio system uses a contact's name as a unique identifier. We are planning to enhance this by
+    switching to using contact's phone number and email as unique identifiers. This change will prevent multiple
+    individuals from sharing the same email or phone number within the system, while allowing the existence of multiple
+    individuals with the same name.
+
+2. **Improved responsiveness of GUI for long text**
+
+    We are aware that excessively long text, like long names, addresses, and remarks etc. might not display fully in
+    a smaller window. While you are able to make the window larger to display more text, we plan to work on
+    improving the responsiveness of our user interface to handle longer inputs.
+
+3. **Improved responsiveness of GUI for different screen sizes**
+
+    We are aware that some UI components overlap with other components when the screen size is reduced.
+    We plan to enhance the responsiveness of our application to ensure it dynamically adapts and supports various
+    display sizes seamlessly in the future.
+
+4. **Improve messages to user**
+
+    We are aware that some of our error and success messages could be more informative for our users.
+    For example, the current success message for edit and add command does not display information
+    on birthday, money owed and days available. We plan to enhance these messages to provide more
+    specific information, ensuring a better user experience.
+
+
 --------------------------------------------------------------------------------------------------------------------
 
 ## **Appendix: Instructions for manual testing**

src/main/java/seedu/address/logic/commands/LendCommand.java

@@ -14,7 +14,7 @@
 import seedu.address.model.person.Person;
 
 /**
- * Lend an amount of money on top of current amount to a person identified
+ * Lends an amount of money on top of current amount to a person identified
  * using the displayed index from the address book.
  */
 public class LendCommand extends Command {
@@ -39,8 +39,8 @@ public class LendCommand extends Command {
      * Returns a new LendCommand object that takes in an Index object
      * and a MoneyOwed object.
      *
-     * @param targetIndex
-     * @param amountToLend
+     * @param targetIndex index of person to lend.
+     * @param amountToLend amount to lend to the person.
      */
     public LendCommand(Index targetIndex, MoneyOwed amountToLend) {
         requireNonNull(targetIndex);

src/main/java/seedu/address/logic/commands/SplitCommand.java

@@ -39,8 +39,8 @@ public class SplitCommand extends Command {
      * Returns a new SplitCommand object that takes in a list of index
      * and a MoneyOwed object.
      *
-     * @param indexListToSplit
-     * @param totalOwed
+     * @param indexListToSplit list of index of person to split with.
+     * @param totalOwed total amount to split.
      */
     public SplitCommand(List<Index> indexListToSplit, MoneyOwed totalOwed) {
         this.indexListToSplit = indexListToSplit;
@@ -50,8 +50,8 @@ public SplitCommand(List<Index> indexListToSplit, MoneyOwed totalOwed) {
     /**
      * Splits the total amount of a group of people.
      *
-     * @param totalAmount
-     * @param numPeople
+     * @param totalAmount total amount to split.
+     * @param numPeople number of people to split with.
      * @return the split amount
      */
     public static Float getSplitAmount(Float totalAmount, int numPeople) {
@@ -63,8 +63,8 @@ public static Float getSplitAmount(Float totalAmount, int numPeople) {
     /**
      * Checks if the index list is valid.
      *
-     * @param indexList
-     * @param sizeOfLastShownList
+     * @param indexList list of index of person to split with.
+     * @param sizeOfLastShownList size of last displayed list.
      * @return true if each index in index list is valid.
      */
     public static boolean hasValidIndexList(List<Index> indexList, int sizeOfLastShownList) {