riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

drivers/saul: Show configuration structs in docs

Browse Source
This commit is contained in:
Joakim Nohlgård 2018-02-15 08:15:51 +01:00
parent 95254990d0
commit 0e5b3d93ec
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
drivers/include/saul/periph.h
View File

@ -19,11 +19,11 @@
#ifndef SAUL_PERIPH_H #ifndef SAUL_PERIPH_H
#define SAUL_PERIPH_H #define SAUL_PERIPH_H
#ifdef MODULE_SAUL_GPIO #if MODULE_SAUL_GPIO || DOXYGEN
#include "periph/gpio.h" #include "periph/gpio.h"
#endif /* MODULE_SAUL_GPIO */ #endif /* MODULE_SAUL_GPIO */
#ifdef MODULE_SAUL_ADC #if MODULE_SAUL_ADC || DOXYGEN
#include "periph/adc.h" #include "periph/adc.h"
#endif /* MODULE_SAUL_ADC */ #endif /* MODULE_SAUL_ADC */
@ -31,7 +31,10 @@
extern "C" { extern "C" {
#endif #endif
#ifdef MODULE_SAUL_GPIO #if MODULE_SAUL_GPIO || DOXYGEN
/**
* @brief SAUL GPIO configuration flags
*/
typedef enum { typedef enum {
SAUL_GPIO_INVERTED = (1 << 0), /**< pin is used as inverted */ SAUL_GPIO_INVERTED = (1 << 0), /**< pin is used as inverted */
SAUL_GPIO_INIT_CLEAR = (1 << 1), /**< set pin inactive after init */ SAUL_GPIO_INIT_CLEAR = (1 << 1), /**< set pin inactive after init */
@ -49,7 +52,7 @@ typedef struct {
} saul_gpio_params_t; } saul_gpio_params_t;
#endif /* MODULE_SAUL_GPIO */ #endif /* MODULE_SAUL_GPIO */
#ifdef MODULE_SAUL_ADC #if MODULE_SAUL_ADC || DOXYGEN
/** /**
* @brief Direct mapped ADC configuration values * @brief Direct mapped ADC configuration values
*/ */