[CS2113-W13-4] BookMarked #19
Conversation
…lowerCommand Add flower command and flower dictionary
…yao-exceptionhandling Custom Exception handling for parser class
| @@ -5,9 +5,261 @@ | |||
| {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} | |||
|
|
|||
| ## Design & implementation | |||
There was a problem hiding this comment.
Is this an empty segment or meant to encapsulate the next section (Design)? If it is meant to encapsulate the next section, consider using different levels of heading. eg. ## for overarching segment, ### for sub segment
| At the start of running the application, `readFileStorage` is called to get the data saved | ||
| from the previous runs of the application. | ||
|
|
||
|  |
There was a problem hiding this comment.
Is the activation bar supposed to be active throughout? This is seen in most of the diagrams of the DG
|
|
||
|
|
||
| ### Command Component | ||
|  |
There was a problem hiding this comment.
Are green/red squares the correct notation to denote public/private attributes?
|
|
||
|
|
||
| ### Command Component | ||
|  |
There was a problem hiding this comment.
Consider making the picture larger as it is currently unreadable
There was a problem hiding this comment.
Yup, the png looks really small, try to make sure it is visible 😃
docs/DeveloperGuide.md
Outdated
| 1. Parses the input to identify the book name specified by the user. | ||
| 2. Searches for the book in an ArrayList of Book instances. | ||
| 3. Verifies if the book is currently borrowed by checking the isBorrowed attribute. | ||
| 4. If the book is borrowed, it calls extendDueDate() on the Book instance to |
There was a problem hiding this comment.
Consider using code blocks to denote functions and technical terms
| #### Exit Command | ||
|
|
||
|
|
||
| ### Book Component | ||
|
|
||
| ## Product scope |
|
|
||
| ### Command Component | ||
|  | ||
|
|
There was a problem hiding this comment.
perhaps the image should be larger for it to be seen better?
docs/DeveloperGuide.md
Outdated
| The 'delete' command interfaces with: | ||
| 1. Ui component : To relay messages back to the user | ||
| 2. Storage component: For persistent storage operation | ||
| 3. Book domain model : represents the state and behaviour of the individual entities |
There was a problem hiding this comment.
perhaps the format of the description should be the same? like all start with capital letters/small letters
eg Book domain model: Represents the state and behaviour .....
| - Iterate through the list of users, by order of index | ||
| - If list of users is empty, throws EmptyListException | ||
| - For each user, iterates through the list of books and prints | ||
|
|
There was a problem hiding this comment.
the ListCommand diagram can't be seen, perhaps you could try reuploading it again?
|  | ||
|
|
||
|
|
||
| #### Edit Command |
There was a problem hiding this comment.
this section is not completed yet
There was a problem hiding this comment.
Overall, the UML diagrams are easy to understand so good job on that! However, it seems really simple and basic (add, delete, find etc). Not too sure what/where are the additional/enhance features that your team added? Try implementing more of them and include them in the DG!
|
|
||
|
|
||
| ### Command Component | ||
|  |
There was a problem hiding this comment.
Yup, the png looks really small, try to make sure it is visible 😃
| At the start of running the application, `readFileStorage` is called to get the data saved | ||
| from the previous runs of the application. | ||
|
|
||
|  |
| `writeBookToTxt` is called. Data stored in will be converted to formatted string and written | ||
| to the txt file, `book.txt`. | ||
|
|
||
|  |
There was a problem hiding this comment.
The images are all of different sizes and quite blurry, try reading it beforehand and adjust the sizes accordingly to make sure it is readable!
docs/DeveloperGuide.md
Outdated
| Whenever the user input in `/help`, "help command" is called and command handled by calling method in UI | ||
| to show to user the messages. | ||
|
|
||
|  |
docs/DeveloperGuide.md
Outdated
| function of each book in the newly sorted ArrayList is then called. | ||
| - If there are no books in the original ArrayList, an exception is thrown and the user is informed of it. | ||
|
|
||
|  |
There was a problem hiding this comment.
Unable to view the png on my side, can try to double check if the image is valid?
| - Books are filtered based on the given keyword. | ||
| - All the filtered books are output to user in a list. | ||
|
|
||
|  |
| #### Exit Command | ||
|
|
||
|
|
||
| ### Book Component | ||
|
|
||
| ## Product scope |
There was a problem hiding this comment.
Missing User Profile, Value Proposition & User Stories?
docs/DeveloperGuide.md
Outdated
| function of each book in the newly sorted ArrayList is then called. | ||
| - If there are no books in the original ArrayList, an exception is thrown and the user is informed of it. | ||
|
|
||
|  |
|  | ||
|
|
||
|
|
||
| #### Delete Command |
There was a problem hiding this comment.
Consider adding a sequence diagram for delete?
docs/DeveloperGuide.md
Outdated
| - The storage component stores the book added and its borrowed status into a text file | ||
|
|
||
|
|
||
|  |
There was a problem hiding this comment.
should the activation bar for Book class be active?
|
|
||
|
|
||
| ### Command Component | ||
|  |
Updated UG
Updated UG for BorrowCommand, ExtendCommand, ReturnCommand
Updated UG for BorrowCommand, ExtendCommand, ReturnCommand
* 'master' of https://github.com/Elyovs/tp: Updated UG for BorrowCommand, ExtendCommand, ReturnCommand Updated UG for BorrowCommand, ExtendCommand, ReturnCommand Updated UG for BorrowCommand, ExtendCommand, ReturnCommand Updated UG for BorrowCommand, ExtendCommand, ReturnCommand Javadocs for AddCommand, BorrowCommand, DeleteCommand, EditCommand, ExtendCommand Javadocs for AddCommand, BorrowCommand, DeleteCommand, EditCommand, ExtendCommand Javadocs for AddCommand, BorrowCommand, DeleteCommand, EditCommand, ExtendCommand Javadocs for AddCommand, BorrowCommand, DeleteCommand, EditCommand, ExtendCommand add test
Branch bug/storage unused print
* 'master' of https://github.com/Elyovs/tp: remove less user friendly "file created" message in the beginning of program remove debugging print un storage validation
Updated UG for BorrowCommand, ExtendCommand, ReturnCommand
Updated UG for BorrowCommand, ExtendCommand, ReturnCommand
Updated UG for BorrowCommand, ExtendCommand, ReturnCommand
Branch dg
parser DG
parser DG
* 'master' of https://github.com/Elyovs/tp: parser DG fix return parser DG Update PPP Simplify class diagram Update kirangeofran.md update diagrams for DG Delete DukeTest Add Parser Sequence diagram
update ug/fix bug
Branch dg/fix user read
Update UG
change from duke
update PPP
update help
BookMarked is a desktop application designed specifically for librarians to streamline the management of library inventory and borrower records. Optimized for use via a Command Line Interface (CLI) while incorporating a Graphical User Interface (GUI), BookMarked offers efficiency and speed in managing tasks.