Skip to content

Commit 8373f8c

Browse files
andy-shevrafaeljw
authored andcommitted
ACPI / utils: Describe function parameters in kernel-doc
Kernel documentation script complains that some of the function parameters are not described: drivers/acpi/utils.c:462: warning: Function parameter or member 'handle' not described in 'acpi_handle_path' drivers/acpi/utils.c:484: warning: Function parameter or member 'level' not described in 'acpi_handle_printk' drivers/acpi/utils.c:484: warning: Function parameter or member 'handle' not described in 'acpi_handle_printk' drivers/acpi/utils.c:484: warning: Function parameter or member 'fmt' not described in 'acpi_handle_printk' drivers/acpi/utils.c:513: warning: Function parameter or member 'descriptor' not described in '__acpi_handle_debug' drivers/acpi/utils.c:513: warning: Function parameter or member 'handle' not described in '__acpi_handle_debug' drivers/acpi/utils.c:513: warning: Function parameter or member 'fmt' not described in '__acpi_handle_debug' Describe function parameters where it's appropriate. Signed-off-by: Andy Shevchenko <[email protected]> Reviewed-by: Mika Westerberg <[email protected]> Signed-off-by: Rafael J. Wysocki <[email protected]>
1 parent 4f5cafb commit 8373f8c

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

drivers/acpi/utils.c

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -455,6 +455,7 @@ EXPORT_SYMBOL(acpi_evaluate_ost);
455455

456456
/**
457457
* acpi_handle_path: Return the object path of handle
458+
* @handle: ACPI device handle
458459
*
459460
* Caller must free the returned buffer
460461
*/
@@ -473,6 +474,9 @@ static char *acpi_handle_path(acpi_handle handle)
473474

474475
/**
475476
* acpi_handle_printk: Print message with ACPI prefix and object path
477+
* @level: log level
478+
* @handle: ACPI device handle
479+
* @fmt: format string
476480
*
477481
* This function is called through acpi_handle_<level> macros and prints
478482
* a message with ACPI prefix and object path. This function acquires
@@ -501,6 +505,9 @@ EXPORT_SYMBOL(acpi_handle_printk);
501505
#if defined(CONFIG_DYNAMIC_DEBUG)
502506
/**
503507
* __acpi_handle_debug: pr_debug with ACPI prefix and object path
508+
* @descriptor: Dynamic Debug descriptor
509+
* @handle: ACPI device handle
510+
* @fmt: format string
504511
*
505512
* This function is called through acpi_handle_debug macro and debug
506513
* prints a message with ACPI prefix and object path. This function

0 commit comments

Comments
 (0)