Skip to content
Snippets Groups Projects
Unverified Commit c4016fcf authored by Joakim Nohlgård's avatar Joakim Nohlgård Committed by GitHub
Browse files

Merge pull request #9978 from haukepetersen/fix_periph_gpiofeaturescopeanddoc

periph/gpio: fix doc of `periph_gpio_irq` submodule
parents bf7bbec6 bd66184e
No related branches found
No related tags found
No related merge requests found
......@@ -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
*
......@@ -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)
......@@ -174,6 +177,9 @@ 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);
......@@ -181,6 +187,9 @@ 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);
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment