DAQ  1.0.0
Data Acquisition System (basic demo)
MainPage.h
Go to the documentation of this file.
1 /*! \brief This file is for doxygen main page.
2  \file MainPage.h
3  \author Alvaro Denis <denisacostaq@gmail.com>
4  \date 7/8/2019
5 
6  \copyright
7  \attention <h1><center><strong>COPYRIGHT &copy; 2019 </strong>
8  [<strong>denisacostaq</strong>][denisacostaq-URL].
9  All rights reserved.</center></h1>
10  \attention This file is part of [<strong>DAQs</strong>][DAQs-URL].
11 
12  Redistribution and use in source and binary forms, with or without
13  modification, are permitted provided that the following conditions
14  are met:
15  - 1. Redistributions of source code must retain the above copyright
16  notice, this list of conditions and the following disclaimer.
17  - 2. Redistributions in binary form must reproduce the above copyright
18  notice, this list of conditions and the following disclaimer in the
19  documentation and/or other materials provided with the distribution.
20  - 3. Neither the name of the University nor the names of its contributors
21  may be used to endorse or promote products derived from this software
22  without specific prior written permission.
23 
24  THIS PRODUCT IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
28  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
29  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
31  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33  THIS PRODUCT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 
35  [denisacostaq-URL]: https://about.me/denisacostaq "Alvaro Denis Acosta"
36  [DAQs-URL]: https://github.com/denisacostaq/DAQs "DAQs"
37  */
38 
39 /*! \mainpage DAQs Source documentation.
40 
41 <h1>Index:</h1>
42 
43 - \subpage protocol "Protocol definition"
44 - \subpage source_code "Download source code"
45 */
46 
47 //-----------------------------------------------------------
48 
49 /*! \page protocol <center>Protocol definition</center>
50 
51 This is the message sequence chart.
52 TODO(denisacostaq@gmail.com): This come from the examples
53 http://www.mcternan.me.uk/mscgen/
54 
55 \mscfile protocol
56 
57 */
58 
59 //-----------------------------------------------------------
60 
61 /*! \page source_code Download source code.
62 - Stable version:\n
63  - [Releases](https://github.com/denisacostaq/DAQs/releases)
64 - Last code:\n
65  - [Nightly builds](https://github.com/denisacostaq/DAQs.git)
66 
67 \subpage code_coverage "Code coverage".
68 */
69 
70 /*! \page code_coverage Code coverage.
71  * The current code coveage value can be found in [the
72  * readme](https://github.com/denisacostaq/DAQs). For more details you can
73  * checkout the [lcov autodeployed
74  * report](https://denisacostaq.github.io/DAQs/coverage_html/index.html) or the
75  * [Source Files on master in the
76  * coverallas](https://coveralls.io/github/denisacostaq/DAQs)
77  */