| Linduino 1.3.0 Linear Technology Arduino-Compatible Demonstration Board

DoxygenExample.ino
Go to the documentation of this file.
1 /*!
2 Doxygen Example
3
4 @verbatim
5
6 ********Insert Notes About The .ino Here
7
8 @endverbatim
9
10 ********Instert HTML Link Here
11
12 Copyright 2018(c) Analog Devices, Inc.
13
14 All rights reserved.
15
16 Redistribution and use in source and binary forms, with or without
17 modification, are permitted provided that the following conditions are met:
18 - Redistributions of source code must retain the above copyright
19 notice, this list of conditions and the following disclaimer.
20 - Redistributions in binary form must reproduce the above copyright
21 notice, this list of conditions and the following disclaimer in
22 the documentation and/or other materials provided with the
23 distribution.
24 - Neither the name of Analog Devices, Inc. nor the names of its
25 contributors may be used to endorse or promote products derived
26 from this software without specific prior written permission.
27 - The use of this software may or may not infringe the patent rights
28 of one or more patent holders. This license does not release you
29 from the requirement that you obtain separate licenses from these
30 patent holders to use this software.
31 - Use of the software either in source or binary form, must be run
32 on or directly connected to an Analog Devices Inc. component.
33
34 THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
35 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
36 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
37 IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
38 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39 LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
40 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
41 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
43 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44 */
45
46 /*! @file
47 @ingroup DoxygenExampleGroupName
48 */
49
50 #include "DoxygenExample.h"
51
52 // Function Declaration
53
54 void function1(int param1, float param2, char param3);
55 float function2();
56
57 // Globals
58 float var1; //!< Message that describes the function of the variable
59 int var2 = 123; //!< Message that describes the function of the variable
60
61 //! Initialize Linduino
62 //! @return void
63 void setup()
64 {
65 }
66
67 //! Repeats Linduino loop
68 //! @return void
69 void loop()
70 {
71 }
72
73 // Function Definition
74
75 //! Message that describes the function
76 //! @return void
77 void function1(int param1, //!< Message that describes the function of the variable
78 float param2, //!< Message that describes the function of the variable
79 char param3 //!< Message that describes the function of the variable
80 )
81 {
82 }
83
84 //! Message that describes the function
85 //! @return Describe the return conditions
86 float function2()
87 {
88 }
89
90
function2
static float function2()
Message that describes the function.
Definition: DoxygenExample.ino:86
DoxygenExample.h
Doxygen Example.
setup
static void setup()
Initialize Linduino.
Definition: DoxygenExample.ino:63
var2
static int var2
Message that describes the function of the variable.
Definition: DoxygenExample.ino:59
loop
static void loop()
Repeats Linduino loop.
Definition: DoxygenExample.ino:69
var1
static float var1
Message that describes the function of the variable.
Definition: DoxygenExample.ino:58
function1
static void function1(int param1, float param2, char param3)
Message that describes the function.
Definition: DoxygenExample.ino:77