foxBMS  1.0.0
The foxBMS Battery Management System API Documentation
doxygen_src.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der
4  * angewandten Forschung e.V. All rights reserved.
5  *
6  * BSD 3-Clause License
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * We kindly request you to use one or more of the following phrases to refer
31  * to foxBMS in your hardware, software, documentation or advertising
32  * materials:
33  *
34  * ″This product uses parts of foxBMS®″
35  *
36  * ″This product includes parts of foxBMS®″
37  *
38  * ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file doxygen_src.h
44  * @author foxBMS Team
45  * @date 2019-06-02 (date of creation)
46  * @updated 2019-06-26 (date of last update)
47  * @ingroup DOXYGEN
48  * @prefix DX
49  *
50  * @brief Mainpage doxygen documentation
51  *
52  */
53 
54 #ifndef FOXBMS__DOXYGEN_SRC_H_
55 #define FOXBMS__DOXYGEN_SRC_H_
56 
57 /**
58  * @mainpage API Documentation
59  *
60  * <h3>Configuration Files</h3>
61  * - @ref ALGORITHMS_CONFIGURATION
62  * - @ref APPLICATION_CONFIGURATION
63  * - @ref DRIVERS_CONFIGURATION
64  * - @ref ENGINE_CONFIGURATION
65  * - @ref TASK_CONFIGURATION
66  *
67  * @defgroup ALGORITHMS_CONFIGURATION Algorithm configuration
68  *
69  * @defgroup APPLICATION_CONFIGURATION Application configuration
70  *
71  * @defgroup DRIVERS_CONFIGURATION Driver configuration
72  *
73  * @defgroup ENGINE_CONFIGURATION Engine configuration
74  *
75  * @defgroup TASK_CONFIGURATION Task configuration
76  */
77 
78 /*========== Includes =======================================================*/
79 
80 /*========== Macros and Definitions =========================================*/
81 
82 /*========== Extern Constant and Variable Declarations ======================*/
83 
84 /*========== Extern Function Prototypes =====================================*/
85 
86 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
87 
88 #endif /* FOXBMS__DOXYGEN_SRC_H_ */