diff options
author | Karl Palsson <karlp@etactica.com> | 2019-06-25 14:03:22 +0300 |
---|---|---|
committer | Karl Palsson <karlp@etactica.com> | 2019-06-26 00:15:19 +0300 |
commit | 25dc3a9b4bf9077b5c78d0768de8c486e0ccbdf2 (patch) | |
tree | 16daabade09431bea7625f5f057939d918ac35cc /include/libopencm3 | |
parent | 4c01e47aed58d7fed433b0f96bce7abe71b24505 (diff) |
doc: efm32: i2c: tag for doxygen
Includes a stub .c file until there are some APIs
Diffstat (limited to 'include/libopencm3')
-rw-r--r-- | include/libopencm3/efm32/common/i2c_common.h | 9 | ||||
-rw-r--r-- | include/libopencm3/efm32/ezr32wg/i2c.h | 13 | ||||
-rw-r--r-- | include/libopencm3/efm32/lg/i2c.h | 13 | ||||
-rw-r--r-- | include/libopencm3/efm32/wg/i2c.h | 13 |
4 files changed, 33 insertions, 15 deletions
diff --git a/include/libopencm3/efm32/common/i2c_common.h b/include/libopencm3/efm32/common/i2c_common.h index 86123c93..c9a53fe9 100644 --- a/include/libopencm3/efm32/common/i2c_common.h +++ b/include/libopencm3/efm32/common/i2c_common.h @@ -1,3 +1,5 @@ +/** @addtogroup i2c_defines + */ /* * This file is part of the libopencm3 project. * @@ -17,12 +19,13 @@ * along with this library. If not, see <http://www.gnu.org/licenses/>. */ -#ifndef LIBOPENCM3_EFM32_I2C_H -#define LIBOPENCM3_EFM32_I2C_H +#pragma once #include <libopencm3/efm32/memorymap.h> #include <libopencm3/cm3/common.h> +/**@{*/ + #define I2C_CTRL(base) MMIO32((base) + 0x000) #define I2C_CMD(base) MMIO32((base) + 0x004) #define I2C_STATE(base) MMIO32((base) + 0x008) @@ -265,4 +268,4 @@ #define I2C1_IEN I2C_IEN(I2C1) #define I2C1_ROUTE I2C_ROUTE(I2C1) -#endif +/**@}*/
\ No newline at end of file diff --git a/include/libopencm3/efm32/ezr32wg/i2c.h b/include/libopencm3/efm32/ezr32wg/i2c.h index e8a3a9c8..50ea556c 100644 --- a/include/libopencm3/efm32/ezr32wg/i2c.h +++ b/include/libopencm3/efm32/ezr32wg/i2c.h @@ -1,3 +1,11 @@ +/** @defgroup i2c_defines I2C Defines + * + * @brief <b>Defined Constants and Types for the I²C module</b> + * + * @ingroup EZR32WG_defines + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -17,9 +25,6 @@ * along with this library. If not, see <http://www.gnu.org/licenses/>. */ -#ifndef LIBOPENCM3_EFM32_EZR32WG_I2C_H -#define LIBOPENCM3_EFM32_EZR32WG_I2C_H +#pragma once #include <libopencm3/efm32/common/i2c_common.h> - -#endif diff --git a/include/libopencm3/efm32/lg/i2c.h b/include/libopencm3/efm32/lg/i2c.h index 6d34803d..9ff55f9f 100644 --- a/include/libopencm3/efm32/lg/i2c.h +++ b/include/libopencm3/efm32/lg/i2c.h @@ -1,3 +1,11 @@ +/** @defgroup i2c_defines I2C Defines + * + * @brief <b>Defined Constants and Types for the I²C module</b> + * + * @ingroup EFM32LG_defines + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -17,9 +25,6 @@ * along with this library. If not, see <http://www.gnu.org/licenses/>. */ -#ifndef LIBOPENCM3_EFM32_LG_I2C_H -#define LIBOPENCM3_EFM32_LG_I2C_H +#pragma once #include <libopencm3/efm32/common/i2c_common.h> - -#endif diff --git a/include/libopencm3/efm32/wg/i2c.h b/include/libopencm3/efm32/wg/i2c.h index 0c40f10e..c137f885 100644 --- a/include/libopencm3/efm32/wg/i2c.h +++ b/include/libopencm3/efm32/wg/i2c.h @@ -1,3 +1,11 @@ +/** @defgroup i2c_defines I2C Defines + * + * @brief <b>Defined Constants and Types for the I²C module</b> + * + * @ingroup EFM32WG_defines + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -17,9 +25,6 @@ * along with this library. If not, see <http://www.gnu.org/licenses/>. */ -#ifndef LIBOPENCM3_EFM32_WG_I2C_H -#define LIBOPENCM3_EFM32_WG_I2C_H +#pragma once #include <libopencm3/efm32/common/i2c_common.h> - -#endif |