Re: [PATCH] iio: imu: inv_mpu6050: fix kernel-doc warnings

[Jonathan Cameron <jic23@kernel.org>]

On Sun, 11 Oct 2026 19:33:57 +0200
Joshua Crofts <joshua.crofts1@gmail.com> wrote:

> On Sun, 11 Oct 2026 10:27:49 +0530
> Arnav Kapoor <kapoorarnav43@gmail.com> wrote:
> 
> > scripts/kernel-doc -Wall reports several warnings for the inv_mpu6050
> > driver:
> > 
> > - inv_mpu_magn_get_scale() only describes @st, not @chan, @val and @val2.
> > - Eight functions use "Returns ..." in the body instead of a "Return:"
> >   section, and inv_mpu6050_set_enable() and
> >   inv_mpu_data_rdy_trigger_set_state() do not describe their return
> >   value at all, e.g.:
> > 
> >     Warning: .../inv_mpu_aux.c:87 No description found for return value
> >     of 'inv_mpu_aux_init'
> > 
> > - int_pin_cfg in struct inv_mpu6050_reg_map is documented with a ';'
> >   instead of a ':' after the name, so kernel-doc does not see it, and
> >   user_ctrl in struct inv_mpu6050_chip_config and startup_time in
> >   struct inv_mpu6050_hw are not documented.
> > 
> > Describe the missing parameters, members and return values, and convert
> > the return value descriptions to "Return:" sections. Where the return
> > value was described before the long description, move it after it, so
> > the description is not parsed as part of the return value section.
> > 
> > With this change, scripts/kernel-doc -Wall reports no warnings for
> > drivers/iio/imu/inv_mpu6050/. Comment-only change.
> > 
> > Assisted-by: LLM
> > Signed-off-by: Arnav Kapoor <kapoorarnav43@gmail.com>
> > ---  
> 
> Reviewed-by: Joshua Crofts <joshua.crofts1@gmail.com>
> 
Applied. Thanks,
J