pm: state: Fix documentation

PM_STATE_INFO_DT_ITEMS_LIST macro documentation was wrong. The example
usage was returning the wrong type and the macro name was also not
correct.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
This commit is contained in:
Flavio Ceolin 2021-06-14 10:37:43 -07:00 committed by Anas Nashif
commit 46029914a7

View file

@ -222,8 +222,8 @@ struct pm_state_info {
* };
*
* Example usage: *
* const enum pm_state states[] =
* PM_STATE_DT_INFO_ITEMS_LIST(DT_NODELABEL(cpu0));
* const struct pm_state_info states[] =
* PM_STATE_INFO_DT_ITEMS_LIST(DT_NODELABEL(cpu0));
*
* @param node_id A node identifier with compatible zephyr,power-state
* @return an array of struct pm_state_info.