doc: fix warnings "Error when parsing function declaration." due to __deprecated

Sphinx's parser gets all confused; add a workaround using @fn,
document the workaround in the contribution section; bug filed with
Sphinx for a permanent sollution.

Change-Id: I0200add092da27206b9d006bb13110c4cc37d0e4
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
This commit is contained in:
Inaky Perez-Gonzalez 2016-06-15 12:15:24 -07:00
commit 9752d3d6b6
3 changed files with 82 additions and 5 deletions

View file

@ -264,6 +264,7 @@ static inline int gpio_pin_read(struct device *port, uint32_t pin,
}
/**
* @fn int gpio_set_callback(struct device *port, gpio_callback_t callback)
* @brief Former way of setting the application's callback.
* @param port Pointer to the device structure for the driver instance.
* @param callback Application's callback (or NULL to unset).