michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: fix "WARNING: Error in type declaration." in callback typedefs

Browse source 
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>
This commit is contained in:
Inaky Perez-Gonzalez 2016-06-15 14:18:38 -07:00
commit 0518063495
8 changed files with 202 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

13
include/gpio.h
View file

@ -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