|
0
|
1 |
/*! \mainpage [APPName]
|
|
|
2 |
*
|
|
|
3 |
* \ref Intro_sec
|
|
|
4 |
* \n\ref Arch_sec
|
|
|
5 |
* \n\ref Design_sec
|
|
|
6 |
*
|
|
|
7 |
* <HR>
|
|
|
8 |
*
|
|
|
9 |
* \section Intro_sec 1. About this Example
|
|
|
10 |
*
|
|
|
11 |
* [a short description on what the example app does (user's point of view)
|
|
|
12 |
* and what functionality it dmeonstrates]
|
|
|
13 |
*
|
|
|
14 |
* \subsection Sub11 1.1 APIs demonstrated
|
|
|
15 |
*
|
|
|
16 |
* [list the APIs whose use the example demonstrates]
|
|
|
17 |
*
|
|
|
18 |
* <HR>
|
|
|
19 |
*
|
|
|
20 |
* \subsection Sub12 1.2 Prerequisites
|
|
|
21 |
*
|
|
|
22 |
* [List here IF the app requires some special prerequisites, such as setting
|
|
|
23 |
* up a server or knowledge of some technology
|
|
|
24 |
* Also mention if some feature that is not available in the emulator is needed]
|
|
|
25 |
*
|
|
|
26 |
* <HR>
|
|
|
27 |
*
|
|
|
28 |
* \section Arch_sec 2. Architecture
|
|
|
29 |
*
|
|
|
30 |
* [Briefly explain the general architecture of the application here]
|
|
|
31 |
*
|
|
|
32 |
* \section Design_sec 3. Design and Implementation
|
|
|
33 |
*
|
|
|
34 |
* \subsection Sub31 3.1 Capabilities
|
|
|
35 |
*
|
|
|
36 |
* [tell what capabilities are needed by the application]
|
|
|
37 |
*
|
|
|
38 |
* [describe the implementation of the app here, highlighting some interesting
|
|
|
39 |
* bits about using the demonstrated APIs]
|
|
|
40 |
*
|
|
|
41 |
*/ |