michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: pm: policy: Hide internal/private fields.

Browse source 
Use INTERNAL_HIDDEN to hide private fields from public
documentation.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2023-09-29 13:04:09 +02:00 • committed by Carles Cufí
commit 9ad403e9ca
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/zephyr/pm/policy.h
View file

@ -40,8 +40,10 @@ typedef void (*pm_policy_latency_changed_cb_t)(int32_t latency);
* @note All fields in this structure are meant for private usage.
*/
struct pm_policy_latency_subscription {
/** @cond INTERNAL_HIDDEN */
sys_snode_t node;
pm_policy_latency_changed_cb_t cb;
/** @endcond */
};
/**
@ -50,8 +52,10 @@ struct pm_policy_latency_subscription {
* @note All fields in this structure are meant for private usage.
*/
struct pm_policy_latency_request {
/** @cond INTERNAL_HIDDEN */
sys_snode_t node;
uint32_t value_us;
/** @endcond */
};
/**
@ -60,8 +64,10 @@ struct pm_policy_latency_request {
* @note All fields in this structure are meant for private usage.
*/
struct pm_policy_event {
/** @cond INTERNAL_HIDDEN */
sys_snode_t node;
uint32_t value_cyc;
/** @endcond */
};
/** @cond INTERNAL_HIDDEN */