public inbox for linux-i2c@vger.kernel.org
 help / color / mirror / Atom feed
From: Wolfram Sang <wsa@the-dreams.de>
To: linux-i2c@vger.kernel.org
Cc: linux-rockchip@lists.infradead.org,
	Heiko Stuebner <heiko@sntech.de>,
	Wolfram Sang <wsa@the-dreams.de>
Subject: [PATCH] i2c: rk3x: add proper kerneldoc header
Date: Thu, 18 Jan 2018 00:18:17 +0100	[thread overview]
Message-ID: <20180117231817.26955-1-wsa@the-dreams.de> (raw)

gcc noticed the kerneldoc was wrongly formatted. Fix it!

drivers/i2c/busses/i2c-rk3x.c:164: warning:
  Cannot understand  * @grf_offset: ...
  on line 164 - I thought it was a doc line

Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
---

It also found this, but I leave this for now. Maybe someone else is interested:

drivers/i2c/busses/i2c-rk3x.c:247: warning: No description found for parameter 'i2c'
drivers/i2c/busses/i2c-rk3x.c:268: warning: No description found for parameter 'i2c'
drivers/i2c/busses/i2c-rk3x.c:306: warning: No description found for parameter 'i2c'
drivers/i2c/busses/i2c-rk3x.c:337: warning: No description found for parameter 'i2c'
drivers/i2c/busses/i2c-rk3x.c:975: warning: No description found for parameter 'i2c'

 drivers/i2c/busses/i2c-rk3x.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/i2c/busses/i2c-rk3x.c b/drivers/i2c/busses/i2c-rk3x.c
index 1f80960c5ae1c8..e1a18d989f8307 100644
--- a/drivers/i2c/busses/i2c-rk3x.c
+++ b/drivers/i2c/busses/i2c-rk3x.c
@@ -161,6 +161,7 @@ enum rk3x_i2c_state {
 };
 
 /**
+ * struct rk3x_i2c_soc_data:
  * @grf_offset: offset inside the grf regmap for setting the i2c type
  * @calc_timings: Callback function for i2c timing information calculated
  */
-- 
2.11.0

             reply	other threads:[~2018-01-17 23:18 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-01-17 23:18 Wolfram Sang [this message]
2018-01-17 23:19 ` [PATCH] i2c: rk3x: add proper kerneldoc header Heiko Stuebner
2018-01-17 23:31 ` Wolfram Sang

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=20180117231817.26955-1-wsa@the-dreams.de \
    --to=wsa@the-dreams.de \
    --cc=heiko@sntech.de \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-rockchip@lists.infradead.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox