ACPI: PM: Improve kerneldoc comments for suspend and hibernation functions
authorYang Li <yang.lee@linux.alibaba.com>
Fri, 15 Mar 2024 00:37:53 +0000 (08:37 +0800)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Fri, 15 Mar 2024 12:26:04 +0000 (13:26 +0100)
commitd7ef570ae0bfd2375a7e7fe468fd6b1b306272c1
tree14b56f82a4e438364ac557ff68e851d2b1ff43ec
parent0a500b810e4aeaadbfff71fa5a0be57d01eb8926
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>
drivers/acpi/sleep.c