diff mbox series

i2c: rk3x: add proper kerneldoc header

Message ID 20180117231817.26955-1-wsa@the-dreams.de
State Accepted
Headers show
Series i2c: rk3x: add proper kerneldoc header | expand

Commit Message

Wolfram Sang Jan. 17, 2018, 11:18 p.m. UTC
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(+)

Comments

Heiko Stuebner Jan. 17, 2018, 11:19 p.m. UTC | #1
Am Donnerstag, 18. Januar 2018, 00:18:17 CET schrieb Wolfram Sang:
> 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>

If you need it,
Reviewed-by: Heiko Stuebner <heiko@sntech.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
>   */
>
Wolfram Sang Jan. 17, 2018, 11:31 p.m. UTC | #2
On Thu, Jan 18, 2018 at 12:18:17AM +0100, Wolfram Sang wrote:
> 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>

Applied to for-next, thanks!
diff mbox series

Patch

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
  */