From dc411a3a8bf5459da92d3c2ab8e3188223b67086 Mon Sep 17 00:00:00 2001 From: Flavio Ceolin Date: Mon, 14 Jun 2021 10:18:55 -0700 Subject: [PATCH] pm: policy: Fix API documentation pm_policy_next_state was not properly documented. Signed-off-by: Flavio Ceolin --- include/pm/policy.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/include/pm/policy.h b/include/pm/policy.h index f70fa414b57..936c223c70c 100644 --- a/include/pm/policy.h +++ b/include/pm/policy.h @@ -14,7 +14,15 @@ extern "C" { #endif /** - * @brief Function to get the next PM state based on the ticks + * @brief Function to get the next PM state + * + * This function is called by the power subsystem when the system is + * idle and returns the most appropriate state based on the number of + * ticks to the next event. + * + * @param ticks The number of ticks to the next scheduled event. + * + * @return The power state the system should use. */ struct pm_state_info pm_policy_next_state(int32_t ticks);