Download CS2101 CS2103 [w15

Transcript
[w15-2j][V0.5]
Contents
Credits ..................................................................................................................................................... 2
User Manual
1
System Requirements ..................................................................................................................... 5
2
Running DoIt! .................................................................................................................................. 5
3
Using DoIt! ...................................................................................................................................... 5
3.1
DoIt! Main ............................................................................................................................... 5
3.2
Quick Add ................................................................................................................................ 6
3.3
Command-line Interface ......................................................................................................... 6
4
Supported Task Types...................................................................................................................... 6
5
Command Reference....................................................................................................................... 6
Developer Guide
1
Introduction .................................................................................................................................... 9
2
Architecture .................................................................................................................................... 9
3
Understanding the Command Flow .............................................................................................. 10
4
Components .................................................................................................................................. 11
4.1
UI ........................................................................................................................................... 11
4.1.1
Classes ........................................................................................................................... 11
4.1.2
Important Methods of the UI Abstract Class ................................................................ 11
4.1.3
GuiCommandBox .......................................................................................................... 12
4.1.4
GuiMain......................................................................................................................... 12
4.1.5
GuiQuick Subclass ......................................................................................................... 12
4.1.6
Cli Subclass .................................................................................................................... 12
4.1.7
CliWithJline Subclass ..................................................................................................... 12
4.1.8
Hint Class ....................................................................................................................... 12
4.2
Logic ...................................................................................................................................... 13
4.2.1
Important APIs .............................................................................................................. 13
4.2.2
LastShownToUi .............................................................................................................. 13
4.2.3
Command Handlers....................................................................................................... 14
4.2.4
Command Parsers ......................................................................................................... 15
4.2.5
Sequence Diagram ........................................................................................................ 16
4.3
Storage .................................................................................................................................. 18
4.3.1
4.4
Database class ............................................................................................................... 18
Shared Components .............................................................................................................. 19
4.4.1
Task................................................................................................................................ 19
3