From 75482aae8a5222ae2d959f8e048f1ae8fbc77a6c Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Mon, 26 Oct 2015 06:18:44 -0400 Subject: [PATCH] doxygen: define groups for drivers Change-Id: Ibf6b6d8586086de5b288fee1e3b4fb1101716fe1 Signed-off-by: Anas Nashif --- include/adc.h | 10 ++++++++++ include/gpio.h | 11 ++++++++++- include/i2c.h | 12 ++++++++++++ include/ipi.h | 11 ++++++++++- include/pinmux.h | 11 +++++++++++ include/pwm.h | 11 +++++++++++ include/spi.h | 11 +++++++++++ include/uart.h | 11 +++++++++++ 8 files changed, 86 insertions(+), 2 deletions(-) diff --git a/include/adc.h b/include/adc.h index ba79a5c875b..fbe7fd8dad0 100644 --- a/include/adc.h +++ b/include/adc.h @@ -28,6 +28,12 @@ #include #include +/** + * @brief ADC Interface + * @defgroup adc_interface ADC Interface + * @ingroup io_interfaces + * @{ + */ /** * Callback type. * ADC_CB_DONE means sampling went fine and is over @@ -164,4 +170,8 @@ static inline int adc_read(struct device *dev, struct adc_seq_table *seq_table) return api->read(dev, seq_table); } +/** + * @} + */ + #endif /* __INCLUDE_ADC_H__ */ diff --git a/include/gpio.h b/include/gpio.h index 68856c8f3fe..a967eaa2884 100644 --- a/include/gpio.h +++ b/include/gpio.h @@ -18,7 +18,12 @@ #ifndef __GPIO_H__ #define __GPIO_H__ - +/** + * @brief GPIO Interface + * @defgroup gpio_interface GPIO Interface + * @ingroup io_interfaces + * @{ + */ #ifdef __cplusplus extern "C" { #endif @@ -273,4 +278,8 @@ static inline int gpio_resume(struct device *port) } #endif +/** + * @} + */ + #endif /* __GPIO_H__ */ diff --git a/include/i2c.h b/include/i2c.h index 42e1c607cb0..4b7a90b9d3b 100644 --- a/include/i2c.h +++ b/include/i2c.h @@ -18,6 +18,13 @@ #ifndef __DRIVERS_I2C_H #define __DRIVERS_I2C_H +/** + * @brief I2C Interface + * @defgroup i2c_interface I2C Interface + * @ingroup io_interfaces + * @{ + */ + #ifdef __cplusplus extern "C" { #endif @@ -267,4 +274,9 @@ static inline int i2c_resume(struct device *dev) } #endif +/** + * @} + */ + + #endif /* __DRIVERS_I2C_H */ diff --git a/include/ipi.h b/include/ipi.h index b14746764c1..3572aa1ea48 100644 --- a/include/ipi.h +++ b/include/ipi.h @@ -19,6 +19,13 @@ #ifndef __INCipih #define __INCipih +/** + * @brief IPI Interface + * @defgroup ipi_interface IPI Interface + * @ingroup io_interfaces + * @{ + */ + #include #include @@ -161,5 +168,7 @@ static inline int ipi_set_enabled(struct device *ipidev, int enable) return api->set_enabled(ipidev, enable); } - +/** + * @} + */ #endif /* __INCipih */ diff --git a/include/pinmux.h b/include/pinmux.h index 4ad89dc391b..dc91233147d 100644 --- a/include/pinmux.h +++ b/include/pinmux.h @@ -18,6 +18,13 @@ #ifndef __INCLUDE_PINMUX_H #define __INCLUDE_PINMUX_H +/** + * @brief Pinmux Interface + * @defgroup pinmux_interface Pinmux Interface + * @ingroup io_interfaces + * @{ + */ + #include #include @@ -57,4 +64,8 @@ static inline uint32_t pinmux_get_pin(struct device *dev, return api->get(dev, pin, func); } +/** + * + * @} + */ #endif /* __INCLUDE_PINMUX_H */ diff --git a/include/pwm.h b/include/pwm.h index f979375ca46..4ea3c0c5df3 100644 --- a/include/pwm.h +++ b/include/pwm.h @@ -22,6 +22,13 @@ #ifndef __PWM_H__ #define __PWM_H__ +/** + * @brief PWM Interface + * @defgroup pwm_interface PWM Interface + * @ingroup io_interfaces + * @{ + */ + #ifdef __cplusplus extern "C" { #endif @@ -194,4 +201,8 @@ static inline int pwm_resume(struct device *dev) } #endif +/** + * @} + */ + #endif /* __PWM_H__ */ diff --git a/include/spi.h b/include/spi.h index 2f7b954f53f..4664bbd4814 100644 --- a/include/spi.h +++ b/include/spi.h @@ -19,6 +19,13 @@ #ifndef __SPI_H__ #define __SPI_H__ +/** + * @brief SPI Interface + * @defgroup spi_interface SPI Interface + * @ingroup io_interfaces + * @{ + */ + #include #include #include @@ -213,4 +220,8 @@ static inline int spi_resume(struct device *dev) } #endif +/** + * @} + */ + #endif /* __SPI_H__ */ diff --git a/include/uart.h b/include/uart.h index ef65939e724..313e7b94170 100644 --- a/include/uart.h +++ b/include/uart.h @@ -19,6 +19,13 @@ #ifndef __INCuarth #define __INCuarth +/** + * @brief UART Interface + * @defgroup uart_interface UART Interface + * @ingroup io_interfaces + * @{ + */ + #ifdef __cplusplus extern "C" { #endif @@ -415,4 +422,8 @@ static inline unsigned int uart_irq_get(struct device *dev) } #endif +/** + * @} + */ + #endif /* __INCuarth */