michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: device.h: hide DEV_* from public documentation

Browse source 
DEV_* error codes are being deprecated so hide them from
public documentation, to prevent mis-use.

Change-Id: Iee2f59502c9470c14ddf2fb1ed19b3526609e43b
Signed-off-by: Daniel Leung <daniel.leung@intel.com>
This commit is contained in:
Daniel Leung 2016-04-15 14:10:00 -07:00 • committed by Anas Nashif
commit acc4eafb11
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
include/device.h
View file

@ -243,6 +243,12 @@ extern struct device_pm_ops device_pm_ops_nop;
*/
#define DEVICE_DECLARE(name) extern struct device DEVICE_NAME_GET(name)
/**
* @cond DEPRECATED_HIDDEN
*
* Hide these from showing in public documentation as these are
* being deprecated.
*/
/*
* DEPRECATED.
*
@ -256,6 +262,7 @@ extern struct device_pm_ops device_pm_ops_nop;
#define DEV_NO_ACCESS (-EACCES) /* Controller not accessible */
#define DEV_NO_SUPPORT (-ENODEV) /* Device type not supported */
#define DEV_NOT_CONFIG (-EPERM) /* Device not configured */
/** @endcond */
struct device;