All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: jdelvare@suse.com, linux@roeck-us.net
Cc: linux-kernel@vger.kernel.org, linux-hwmon@vger.kernel.org,
	Lee Jones <lee.jones@linaro.org>, "Andrew F. Davis" <afd@ti.com>
Subject: [PATCH 2/3] hwmon: ina3221: Demote seemingly unintentional kerneldoc header
Date: Thu, 12 Nov 2020 09:57:14 +0000	[thread overview]
Message-ID: <20201112095715.1993117-3-lee.jones@linaro.org> (raw)
In-Reply-To: <20201112095715.1993117-1-lee.jones@linaro.org>

This is the only use of kerneldoc in the sourcefile and no
descriptions are provided.

Fixes the following W=1 kernel build warning(s):

 drivers/hwmon/ina3221.c:152: warning: Function parameter or member 'ina' not described in 'ina3221_summation_shunt_resistor'

Cc: "Andrew F. Davis" <afd@ti.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/hwmon/ina3221.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/hwmon/ina3221.c b/drivers/hwmon/ina3221.c
index 41fb17e0d6416..72cfdc007e609 100644
--- a/drivers/hwmon/ina3221.c
+++ b/drivers/hwmon/ina3221.c
@@ -139,7 +139,7 @@ static inline bool ina3221_is_enabled(struct ina3221_data *ina, int channel)
 	       (ina->reg_config & INA3221_CONFIG_CHx_EN(channel));
 }
 
-/**
+/*
  * Helper function to return the resistor value for current summation.
  *
  * There is a condition to calculate current summation -- all the shunt
-- 
2.25.1


  parent reply	other threads:[~2020-11-12  9:57 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-12  9:57 [PATCH 0/3] Rid W=1 warnings from HWMON Lee Jones
2020-11-12  9:57 ` Lee Jones
2020-11-12  9:57 ` [PATCH 1/3] hwmon: adm1177: Fix kerneldoc attribute formatting Lee Jones
2020-11-12  9:57 ` Lee Jones [this message]
2020-11-12  9:57 ` [PATCH 3/3] hwmon: ibmpowernv: Silence strncpy() warning Lee Jones
2020-11-12  9:57   ` Lee Jones

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201112095715.1993117-3-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=afd@ti.com \
    --cc=jdelvare@suse.com \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.