michaelh/zephyr
1
0
Fork 0
Code Releases Activity

pm: device: hide internal flags from public docs

Browse source 
The PM flags are only used internally, so there is no need to include
them in the documentation.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-10-29 11:48:33 +02:00 • committed by Carles Cufí
commit 793c8ddd63
1 changed files with 17 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

30
include/pm/device.h
View file

@ -21,8 +21,25 @@ extern "C" {
* @{ * @{
*/ */
/** @cond INTERNAL_HIDDEN */
struct device; struct device;
/** @brief Device PM flags. */
enum pm_device_flag {
/** Indicate if the device is busy or not. */
PM_DEVICE_FLAG_BUSY,
/**
* Indicates whether or not the device is capable of waking the system
* up.
*/
PM_DEVICE_FLAG_WS_CAPABLE,
/** Indicates if the device is being used as wakeup source. */
PM_DEVICE_FLAG_WS_ENABLED,
};
/** @endcond */
/** @brief Device power states. */ /** @brief Device power states. */
enum pm_device_state { enum pm_device_state {
/** Device is in active or regular state. */ /** Device is in active or regular state. */
@ -45,19 +62,6 @@ enum pm_device_state {
PM_DEVICE_STATE_OFF PM_DEVICE_STATE_OFF
}; };
/** @brief Device PM flags. */
enum pm_device_flag {
/** Indicate if the device is busy or not. */
PM_DEVICE_FLAG_BUSY,
/**
* Indicates whether or not the device is capable of waking the system
* up.
*/
PM_DEVICE_FLAG_WS_CAPABLE,
/** Indicates if the device is being used as wakeup source. */
PM_DEVICE_FLAG_WS_ENABLED,
};
/** @brief Device PM actions. */ /** @brief Device PM actions. */
enum pm_device_action { enum pm_device_action {
/** Suspend. */ /** Suspend. */