| Message ID | 20240126-gix-mtk-warnings-v1-6-eed7865fce18@chromium.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | media: kerneldoc warnings | expand |
On 1/26/24 15:16, Ricardo Ribalda wrote: > Kerneldoc does not seem to understand that embed doc: > drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'write' description in 'ccs_quirk' > drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'reg' description in 'ccs_quirk' > drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'val' description in 'ccs_quirk' > Correct. It's never tried to understand that AFAIK. > Convert into a standard doc. > > Signed-off-by: Ricardo Ribalda <ribalda@chromium.org> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Thanks. > --- > drivers/media/i2c/ccs/ccs-quirk.h | 8 ++++---- > 1 file changed, 4 insertions(+), 4 deletions(-) > > diff --git a/drivers/media/i2c/ccs/ccs-quirk.h b/drivers/media/i2c/ccs/ccs-quirk.h > index 0b1a64958d71..392c97109617 100644 > --- a/drivers/media/i2c/ccs/ccs-quirk.h > +++ b/drivers/media/i2c/ccs/ccs-quirk.h > @@ -28,11 +28,11 @@ struct ccs_sensor; > * @reg_access: Register access quirk. The quirk may divert the access > * to another register, or no register at all. > * > - * @write: Is this read (false) or write (true) access? > - * @reg: Pointer to the register to access > - * @value: Register value, set by the caller on write, or > + * -write: Is this read (false) or write (true) access? > + * -reg: Pointer to the register to access > + * -val: Register value, set by the caller on write, or > * by the quirk on read > - * @return: 0 on success, -ENOIOCTLCMD if no register > + * -return: 0 on success, -ENOIOCTLCMD if no register > * access may be done by the caller (default read > * value is zero), else negative error code on error > * @flags: Quirk flags >
diff --git a/drivers/media/i2c/ccs/ccs-quirk.h b/drivers/media/i2c/ccs/ccs-quirk.h index 0b1a64958d71..392c97109617 100644 --- a/drivers/media/i2c/ccs/ccs-quirk.h +++ b/drivers/media/i2c/ccs/ccs-quirk.h @@ -28,11 +28,11 @@ struct ccs_sensor; * @reg_access: Register access quirk. The quirk may divert the access * to another register, or no register at all. * - * @write: Is this read (false) or write (true) access? - * @reg: Pointer to the register to access - * @value: Register value, set by the caller on write, or + * -write: Is this read (false) or write (true) access? + * -reg: Pointer to the register to access + * -val: Register value, set by the caller on write, or * by the quirk on read - * @return: 0 on success, -ENOIOCTLCMD if no register + * -return: 0 on success, -ENOIOCTLCMD if no register * access may be done by the caller (default read * value is zero), else negative error code on error * @flags: Quirk flags
Kerneldoc does not seem to understand that embed doc: drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'write' description in 'ccs_quirk' drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'reg' description in 'ccs_quirk' drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'val' description in 'ccs_quirk' Convert into a standard doc. Signed-off-by: Ricardo Ribalda <ribalda@chromium.org> --- drivers/media/i2c/ccs/ccs-quirk.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)