michaelh/zephyr
1
0
Fork 0
Code Releases Activity

pm: device: hide struct pm_device from docs

Browse source 
This structure is meant for internal usage, same as its initializer.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-10-29 16:07:22 +02:00 • committed by Carles Cufí
commit 6bb9cab0ef
1 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/pm/device.h
View file

@ -74,6 +74,8 @@ enum pm_device_action {
PM_DEVICE_ACTION_FORCE_SUSPEND, PM_DEVICE_ACTION_FORCE_SUSPEND,
}; };
/** @cond INTERNAL_HIDDEN */
/** /**
* @brief Device PM action callback. * @brief Device PM action callback.
* *
@ -125,7 +127,7 @@ struct pm_device {
/** /**
* @brief Utility macro to initialize #pm_device. * @brief Utility macro to initialize #pm_device.
* *
* @note DT_PROP_OR is used to retrieve the wakeup_source property because * @note #DT_PROP_OR is used to retrieve the wakeup_source property because
* it may not be defined on all devices. * it may not be defined on all devices.
* *
* @param obj Name of the #pm_device structure being initialized. * @param obj Name of the #pm_device structure being initialized.
@ -143,6 +145,8 @@ struct pm_device {
(0)) << PM_DEVICE_FLAG_WS_CAPABLE), \ (0)) << PM_DEVICE_FLAG_WS_CAPABLE), \
} }
/** @endcond */
/** /**
* @brief Get name of device PM state * @brief Get name of device PM state
* *