Skip to content

Commit 17fe3ec

Browse files
rddunlapij-intel
authored andcommitted
platform/x86: thinkpad_acpi: fix kernel-doc warnings
Add a function's return description and don't misuse "/**" for non-kernel-doc comments to prevent warnings from scripts/kernel-doc. thinkpad_acpi.c:523: warning: No description found for return value of 'tpacpi_check_quirks' thinkpad_acpi.c:9307: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst thinkpad_acpi.c:9307: warning: missing initial short description on line: * This evaluates a ACPI method call specific to the battery Signed-off-by: Randy Dunlap <[email protected]> Cc: Henrique de Moraes Holschuh <[email protected]> Cc: Hans de Goede <[email protected]> Cc: Ilpo Järvinen <[email protected]> CC: [email protected] CC: [email protected] Reviewed-by: [email protected] Link: https://lore.kernel.org/r/[email protected] Reviewed-by: Ilpo Järvinen <[email protected]> Signed-off-by: Ilpo Järvinen <[email protected]>
1 parent 14c200b commit 17fe3ec

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

drivers/platform/x86/thinkpad_acpi.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -512,10 +512,10 @@ struct tpacpi_quirk {
512512
* Iterates over a quirks list until one is found that matches the
513513
* ThinkPad's vendor, BIOS and EC model.
514514
*
515-
* Returns 0 if nothing matches, otherwise returns the quirks field of
515+
* Returns: %0 if nothing matches, otherwise returns the quirks field of
516516
* the matching &struct tpacpi_quirk entry.
517517
*
518-
* The match criteria is: vendor, ec and bios much match.
518+
* The match criteria is: vendor, ec and bios must match.
519519
*/
520520
static unsigned long __init tpacpi_check_quirks(
521521
const struct tpacpi_quirk *qlist,
@@ -9303,7 +9303,7 @@ static struct tpacpi_battery_driver_data battery_info;
93039303

93049304
/* ACPI helpers/functions/probes */
93059305

9306-
/**
9306+
/*
93079307
* This evaluates a ACPI method call specific to the battery
93089308
* ACPI extension. The specifics are that an error is marked
93099309
* in the 32rd bit of the response, so we just check that here.

0 commit comments

Comments
 (0)