Unverified Commit 17fe3ec0 authored Dec 05, 2023 by Randy Dunlap Committed by Ilpo Järvinen Dec 08, 2023

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 <rdunlap@infradead.org>
Cc: Henrique de Moraes Holschuh <hmh@hmh.eng.br>
Cc: Hans de Goede <hdegoede@redhat.com>
Cc: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
CC: ibm-acpi-devel@lists.sourceforge.net
CC: platform-driver-x86@vger.kernel.org
Reviewed-by:  <mpearson-lenovo@squebb.ca>
Link: https://lore.kernel.org/r/20231206060144.8260-1-rdunlap@infradead.org


Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>

parent 14c200b7

drivers/platform/x86/thinkpad_acpi.c

+3 −3

Original line number	Diff line number	Diff line
		@@ -512,10 +512,10 @@ struct tpacpi_quirk {
		* Iterates over a quirks list until one is found that matches the
		* ThinkPad's vendor, BIOS and EC model.
		*
		* Returns 0 if nothing matches, otherwise returns the quirks field of
		* Returns: %0 if nothing matches, otherwise returns the quirks field of
		* the matching &struct tpacpi_quirk entry.
		*
		* The match criteria is: vendor, ec and bios much match.
		* The match criteria is: vendor, ec and bios must match.
		*/
		static unsigned long __init tpacpi_check_quirks(
		const struct tpacpi_quirk *qlist,
		@@ -9303,7 +9303,7 @@ static struct tpacpi_battery_driver_data battery_info;

		/* ACPI helpers/functions/probes */

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