michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Fix doxygen warnings about params not documented

Browse source 
Some macros were inheriting from other macros with minor
differences.  They were referring to the description of the
the params from the original macro.  However, doxygen does
not recognize that.  Replaced with another doxygen command
that actually pulls in the descriptions avoiding the warnings.

Change-Id: I8545a965ee64f7800f54208e330de7b2c7a611eb
Jira: ZEP-460
Signed-off-by: Ramesh Thomas <ramesh.thomas@intel.com>
This commit is contained in:
Ramesh Thomas 2016-06-16 19:42:04 -07:00 • committed by Inaky Perez-Gonzalez
commit b4f77ee70a
1 changed files with 10 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

30
include/device.h
View file

@ -91,14 +91,11 @@ extern "C" {
* @brief Create device object and set it up for boot time initialization,
* with the option to set driver_api.
*
* @details This macro defines a device object that is automatically
* configured by the kernel during system initialization. The driver_api
* is also be set here, eliminating the need to do that during initialization.
*
* \see DEVICE_INIT() for description on other parameters.
*
* @copydetails DEVICE_INIT
* @param api Provides an initial pointer to the API function struct
* used by the driver. Can be NULL.
* @details The driver api is also set here, eliminating the need to do that
* during initialization.
*/
#ifndef CONFIG_DEVICE_POWER_MANAGEMENT
@ -129,13 +126,11 @@ extern "C" {
* @brief Create device object and set it up for boot time initialization,
* with the options to set driver_api and device_pm_ops.
*
* @details This macro defines a device object that is automatically
* configured by the kernel during system initialization. This driver_api
* and device_pm_ops are also be set here.
*
* @param device_pm_ops Address to the device_pm_ops structure of the driver.
*
* \see DEVICE_AND_API_INIT() for description on other parameters.
* @copydetails DEVICE_INIT_PM
* @param api Provides an initial pointer to the API function struct
* used by the driver. Can be NULL.
* @details The driver api is also set here, eliminating the need to do that
* during initialization.
*/
#define DEVICE_AND_API_INIT_PM(dev_name, drv_name, init_fn, device_pm_ops, \
@ -159,15 +154,10 @@ extern "C" {
* @def DEVICE_INIT_PM
*
* @brief Create device object and set it up for boot time initialization,
* with the options to device_pm_ops.
*
* @details This macro defines a device object that is automatically
* configured by the kernel during system initialization. This device_pm_ops
* is also be set here.
* with the option to device_pm_ops.
*
* @copydetails DEVICE_INIT
* @param device_pm_ops Address to the device_pm_ops structure of the driver.
*
* \see DEVICE_INIT() for description on other parameters.
*/
#define DEVICE_INIT_PM(dev_name, drv_name, init_fn, device_pm_ops, \