platform/x86: thinkpad_acpi: fix kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Wed, 6 Dec 2023 06:01:43 +0000 (22:01 -0800)
committerIlpo Järvinen <ilpo.jarvinen@linux.intel.com>
Fri, 8 Dec 2023 11:02:24 +0000 (13:02 +0200)
commit17fe3ec0c110b4afc04052e2a33b146766aac8a1
tree4d834ee873ddcc043f4e6e60e879220fa1cb16c6
parent14c200b7ca46b9a9f4af9e81d258a58274320b6f
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>
drivers/platform/x86/thinkpad_acpi.c