diff options
| author | Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com> | 2016-06-15 14:18:38 -0700 |
|---|---|---|
| committer | Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com> | 2016-06-16 13:11:06 -0700 |
| commit | 0518063495ab68acd9e8cd55480b50e7f0ba1d09 (patch) | |
| tree | 6fb9168fe274b10a13e4856ab11942a6d7129bf7 /include/gpio.h | |
| parent | 9752d3d6b6ad8693bc3be71b1ee2d65a6818bd62 (diff) | |
doc: fix "WARNING: Error in type declaration." in callback typedefs
Some function *typedefs* confuse the *Sphynx* / *breathe* parser [see
the patch for full details]. Implement a workaround (defining the name
with @typedef), add workaround documentation and file a bug with the
sphinx/breathe developers.
Change-Id: I7f3dba4a53d0cc73e12f02511a5f85526f357b5f
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Diffstat (limited to 'include/gpio.h')
| -rw-r--r-- | include/gpio.h | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/include/gpio.h b/include/gpio.h index fd44a4227..7477fd9fd 100644 --- a/include/gpio.h +++ b/include/gpio.h @@ -126,10 +126,11 @@ extern "C" { #define GPIO_PIN_DISABLE (1 << 11) /** + * @typedef gpio_callback_t * @brief Define the application callback function signature. * - * @param port Device struct for the GPIO device. - * @param pin The pin that triggers the callback. + * @param "struct device *port" Device struct for the GPIO device. + * @param "uint32_t pin" The pin that triggers the callback. * * Note: This is the former callback signature used to set a unique * callback (API v1.0) through gpio_set_callback(). The new @@ -141,11 +142,13 @@ typedef void (*gpio_callback_t)(struct device *port, uint32_t pin); struct gpio_callback; /** + * @typedef gpio_callback_handler_t * @brief Define the application callback handler function signature * - * @param port Device struct for the GPIO device. - * @param cb Original struct gpio_callback owning this handler - * @param pins Mask of pins that triggers the callback handler + * @param "struct device *port" Device struct for the GPIO device. + * @param "struct gpio_callback *cb" Original struct gpio_callback + * owning this handler + * @param "uint32_t pins" Mask of pins that triggers the callback handler * * Note: cb pointer can be used to retrieve private data through * CONTAINER_OF() if original struct gpio_callback is stored in |