From acc4eafb115ccbeb146e0b56adcd24ff2df032ed Mon Sep 17 00:00:00 2001 From: Daniel Leung Date: Fri, 15 Apr 2016 14:10:00 -0700 Subject: [PATCH] doc: device.h: hide DEV_* from public documentation DEV_* error codes are being deprecated so hide them from public documentation, to prevent mis-use. Change-Id: Iee2f59502c9470c14ddf2fb1ed19b3526609e43b Signed-off-by: Daniel Leung --- include/device.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/include/device.h b/include/device.h index 3ae69530676..50cf1d6a515 100644 --- a/include/device.h +++ b/include/device.h @@ -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;