| Linduino 1.3.0 Linear Technology Arduino-Compatible Demonstration Board

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