ACPI: PM: Improve kerneldoc comments for suspend and hibernation functions

This patch enhances the documentation for the ACPI power management
functions related to system suspend and hibernation.

This includes the use of kernel-doc style comments which provide
developers with clearer guidance on the usage and expectations of
these functions.

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
[ rjw: Subject edits ]
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

diff --git a/drivers/acpi/sleep.c b/drivers/acpi/sleep.c
index 808484d11209761d93e10a6e4937a3e4a75d34b2..daf351007b6964beac2ff5694008b3afecac9d3d 100644 (file)
--- a/drivers/acpi/sleep.c
+++ b/drivers/acpi/sleep.c
@@ -514,6 +514,7 @@ static void acpi_pm_finish(void)
 
 /**
  * acpi_pm_start - Start system PM transition.
+ * @acpi_state: The target ACPI power state to transition to.
  */
 static void acpi_pm_start(u32 acpi_state)
 {
@@ -552,8 +553,9 @@ static u32 acpi_suspend_states[] = {
 };
 
 /**
- *     acpi_suspend_begin - Set the target system sleep state to the state
- *             associated with given @pm_state, if supported.
+ * acpi_suspend_begin - Set the target system sleep state to the state
+ *     associated with given @pm_state, if supported.
+ * @pm_state: The target system power management state.
  */
 static int acpi_suspend_begin(suspend_state_t pm_state)
 {
@@ -683,10 +685,11 @@ static const struct platform_suspend_ops acpi_suspend_ops = {
 };
 
 /**
- *     acpi_suspend_begin_old - Set the target system sleep state to the
- *             state associated with given @pm_state, if supported, and
- *             execute the _PTS control method.  This function is used if the
- *             pre-ACPI 2.0 suspend ordering has been requested.
+ * acpi_suspend_begin_old - Set the target system sleep state to the
+ *     state associated with given @pm_state, if supported, and
+ *     execute the _PTS control method.  This function is used if the
+ *     pre-ACPI 2.0 suspend ordering has been requested.
+ * @pm_state: The target suspend state for the system.
  */
 static int acpi_suspend_begin_old(suspend_state_t pm_state)
 {
@@ -979,10 +982,11 @@ static const struct platform_hibernation_ops acpi_hibernation_ops = {
 };
 
 /**
- *     acpi_hibernation_begin_old - Set the target system sleep state to
- *             ACPI_STATE_S4 and execute the _PTS control method.  This
- *             function is used if the pre-ACPI 2.0 suspend ordering has been
- *             requested.
+ * acpi_hibernation_begin_old - Set the target system sleep state to
+ *     ACPI_STATE_S4 and execute the _PTS control method.  This
+ *     function is used if the pre-ACPI 2.0 suspend ordering has been
+ *     requested.
+ * @stage: The power management event message.
  */
 static int acpi_hibernation_begin_old(pm_message_t stage)
 {