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