[PATCH] thermal: max77620: fix kernel-doc for max77620_thermal_read_temp

Vivek BalachandharTN posted 1 patch 15 hours ago
drivers/thermal/max77620_thermal.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] thermal: max77620: fix kernel-doc for max77620_thermal_read_temp
Posted by Vivek BalachandharTN 15 hours ago
Building with W=1 reports a kernel-doc warning in
drivers/thermal/max77620_thermal.c:

  Warning: max77620_thermal.c:47 function parameter 'tz'
  not described in 'max77620_thermal_read_temp'

Update the kernel-doc comment for max77620_thermal_read_temp() to match
the current function prototype. Replace the stale @data entry with @tz
and describe the thermal zone device argument so that all parameters are
documented.

This fixes the W=1 kernel-doc warning and keeps the documentation in
sync with the code.

Signed-off-by: Vivek BalachandharTN <vivek.balachandhar@gmail.com>
---
 drivers/thermal/max77620_thermal.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/thermal/max77620_thermal.c b/drivers/thermal/max77620_thermal.c
index 85a12e98d6dc..8d37a04eb5a8 100644
--- 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:	Thermal zone device
  * @temp:	Temperature in millidegrees Celsius
  *
  * The actual temperature of PMIC die is not available from PMIC.
-- 
2.34.1