-
Notifications
You must be signed in to change notification settings - Fork 25
/
design.dox
28 lines (28 loc) · 1.06 KB
/
design.dox
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
/**
* \mainpage Overall design of Tarsnap-GUI
*
* \section Objects Main objects
*
* - Frontend: \ref MainWindow or \ref SetupWizard
* - Backend: \ref TaskManager
* - Overall owner: \ref AppGui or \ref AppCmdline
*
* \section signals Signals between frontend and backend
*
* The connections between the frontend and backend are defined in
* src/app-gui.cpp. Naming conventions:
* - Following the convention of the Qt objects, signals should be
* in the past tense, while slots should be present tense. For
* example, a typical "query chain" might be:
* <table><tr>
* <td>FRONTEND</td><td>SIGNAL</td><td>\ref tarsnapVersionRequested</td>
* </tr><tr>
* <td>BACKEND</td><td>SLOT</td><td>\ref tarsnapVersionFind</td>
* </tr><tr>
* <td>BACKEND</td><td>SIGNAL</td><td>\ref tarsnapVersionFound</td>
* </tr><tr>
* <td>FRONTEND</td><td>SLOT</td><td>\ref tarsnapVersionResponse</td>
* </tr></table>
* If at all possible, keep the same prefix for all four items;
* this will make grepping much easier.
*/