Skip to content

Commit

Permalink
periph/gpio: re-add irq functions to doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
haukepetersen committed Sep 21, 2018
1 parent c7e6d15 commit bd66184
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion drivers/include/periph/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ typedef struct {
*/
int gpio_init(gpio_t pin, gpio_mode_t mode);

#ifdef MODULE_PERIPH_GPIO_IRQ
#if defined(MODULE_PERIPH_GPIO_IRQ) || defined(DOXYGEN)
/**
* @brief Initialize a GPIO pin for external interrupt usage
*
Expand All @@ -157,6 +157,9 @@ int gpio_init(gpio_t pin, gpio_mode_t mode);
*
* The interrupt is activated automatically after the initialization.
*
* @note You have to add the module `periph_gpio_irq` to your project to
* enable this function
*
* @param[in] pin pin to initialize
* @param[in] mode mode of the pin, see @c gpio_mode_t
* @param[in] flank define the active flank(s)
Expand All @@ -174,13 +177,19 @@ int gpio_init_int(gpio_t pin, gpio_mode_t mode, gpio_flank_t flank,
/**
* @brief Enable pin interrupt if configured as interrupt source
*
* @note You have to add the module `periph_gpio_irq` to your project to
* enable this function
*
* @param[in] pin the pin to enable the interrupt for
*/
void gpio_irq_enable(gpio_t pin);

/**
* @brief Disable the pin interrupt if configured as interrupt source
*
* @note You have to add the module `periph_gpio_irq` to your project to
* enable this function
*
* @param[in] pin the pin to disable the interrupt for
*/
void gpio_irq_disable(gpio_t pin);
Expand Down

0 comments on commit bd66184

Please sign in to comment.