linux-kernel - [PATCH] thermal: max7620: fix all kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [day] [month] [year] [list]

Date: Thu, 21 Dec 2023 22:19:31 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	"Rafael J . Wysocki" <rafael@...nel.org>,
	Daniel Lezcano <daniel.lezcano@...aro.org>,
	Zhang Rui <rui.zhang@...el.com>,
	Lukasz Luba <lukasz.luba@....com>,
	linux-pm@...r.kernel.org
Subject: [PATCH] thermal: max7620: fix all kernel-doc warnings

Correct all kernel-doc notation to prevent warnings from
scripts/kernel-doc:

max77620_thermal.c:48: warning: Function parameter or member 'tz' not described in 'max77620_thermal_read_temp'
max77620_thermal.c:48: warning: Excess function parameter 'data' description in 'max77620_thermal_read_temp'
max77620_thermal.c:48: warning: No description found for return value of 'max77620_thermal_read_temp'

Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
Cc: Rafael J. Wysocki <rafael@...nel.org>
Cc: Daniel Lezcano <daniel.lezcano@...aro.org>
Cc: Zhang Rui <rui.zhang@...el.com>
Cc: Lukasz Luba <lukasz.luba@....com>
Cc: linux-pm@...r.kernel.org
---
 drivers/thermal/max77620_thermal.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff -- a/drivers/thermal/max77620_thermal.c b/drivers/thermal/max77620_thermal.c
--- a/drivers/thermal/max77620_thermal.c
+++ b/drivers/thermal/max77620_thermal.c
@@ -32,7 +32,7 @@ struct max77620_therm_info {
 
 /**
  * max77620_thermal_read_temp: Read PMIC die temperatue.
- * @data:	Device specific data.
+ * @tz:		pointer to &thermal_zone_device
  * @temp:	Temperature in millidegrees Celsius
  *
  * The actual temperature of PMIC die is not available from PMIC.
@@ -41,7 +41,7 @@ struct max77620_therm_info {
  * If threshold has not been crossed then assume die temperature as 100degC
  * else 120degC or 140deG based on the PMIC die temp threshold status.
  *
- * Return 0 on success otherwise error number to show reason of failure.
+ * Return: %0 on success otherwise error number to show reason of failure.
  */
 
 static int max77620_thermal_read_temp(struct thermal_zone_device *tz, int *temp)