| Message ID | 20210311102022.96954-8-hverkuil-cisco@xs4all.nl |
|---|---|
| State | Accepted |
| Commit | 75e2ddb181271d067412cdb7aa87a55736adb246 |
| Headers | show |
| Series | media platform: fix kernel-doc formatting | expand |
Hi Hans, Thanks for the fix. On Thu, 2021-03-11 at 11:20 +0100, Hans Verkuil wrote: > - @h264_dec was not documented, add that trivial change > - it is not possible to document a global variable in kernel-doc, > change to use 'DOC:' instead > - fix mismatched struct name (hantro_vp8d_hw_ctx -> hantro_vp8_dec_hw_ctx) > > Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> > Cc: Ezequiel Garcia <ezequiel@collabora.com> Reviewed-by: Ezequiel Garcia <ezequiel@collabora.com> Thanks, Ezequiel > --- > drivers/staging/media/hantro/hantro.h | 3 ++- > drivers/staging/media/hantro/hantro_hw.h | 2 +- > 2 files changed, 3 insertions(+), 2 deletions(-) > > diff --git a/drivers/staging/media/hantro/hantro.h b/drivers/staging/media/hantro/hantro.h > index 65f9f7ea7dcf..6c1b888abe75 100644 > --- a/drivers/staging/media/hantro/hantro.h > +++ b/drivers/staging/media/hantro/hantro.h > @@ -214,6 +214,7 @@ struct hantro_dev { > * > * @codec_ops: Set of operations related to codec mode. > * @postproc: Post-processing context. > + * @h264_dec: H.264-decoding context. > * @jpeg_enc: JPEG-encoding context. > * @mpeg2_dec: MPEG-2-decoding context. > * @vp8_dec: VP8-decoding context. > @@ -293,7 +294,7 @@ struct hantro_postproc_regs { > /* Logging helpers */ > > /** > - * debug - Module parameter to control level of debugging messages. > + * DOC: hantro_debug: Module parameter to control level of debugging messages. > * > * Level of debugging messages can be controlled by bits of > * module parameter called "debug". Meaning of particular > diff --git a/drivers/staging/media/hantro/hantro_hw.h b/drivers/staging/media/hantro/hantro_hw.h > index 34c9e4649a25..65a9eaf5bb18 100644 > --- a/drivers/staging/media/hantro/hantro_hw.h > +++ b/drivers/staging/media/hantro/hantro_hw.h > @@ -99,7 +99,7 @@ struct hantro_mpeg2_dec_hw_ctx { > }; > > /** > - * struct hantro_vp8d_hw_ctx > + * struct hantro_vp8_dec_hw_ctx > * @segment_map: Segment map buffer. > * @prob_tbl: Probability table buffer. > */
diff --git a/drivers/staging/media/hantro/hantro.h b/drivers/staging/media/hantro/hantro.h index 65f9f7ea7dcf..6c1b888abe75 100644 --- a/drivers/staging/media/hantro/hantro.h +++ b/drivers/staging/media/hantro/hantro.h @@ -214,6 +214,7 @@ struct hantro_dev { * * @codec_ops: Set of operations related to codec mode. * @postproc: Post-processing context. + * @h264_dec: H.264-decoding context. * @jpeg_enc: JPEG-encoding context. * @mpeg2_dec: MPEG-2-decoding context. * @vp8_dec: VP8-decoding context. @@ -293,7 +294,7 @@ struct hantro_postproc_regs { /* Logging helpers */ /** - * debug - Module parameter to control level of debugging messages. + * DOC: hantro_debug: Module parameter to control level of debugging messages. * * Level of debugging messages can be controlled by bits of * module parameter called "debug". Meaning of particular diff --git a/drivers/staging/media/hantro/hantro_hw.h b/drivers/staging/media/hantro/hantro_hw.h index 34c9e4649a25..65a9eaf5bb18 100644 --- a/drivers/staging/media/hantro/hantro_hw.h +++ b/drivers/staging/media/hantro/hantro_hw.h @@ -99,7 +99,7 @@ struct hantro_mpeg2_dec_hw_ctx { }; /** - * struct hantro_vp8d_hw_ctx + * struct hantro_vp8_dec_hw_ctx * @segment_map: Segment map buffer. * @prob_tbl: Probability table buffer. */
- @h264_dec was not documented, add that trivial change - it is not possible to document a global variable in kernel-doc, change to use 'DOC:' instead - fix mismatched struct name (hantro_vp8d_hw_ctx -> hantro_vp8_dec_hw_ctx) Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Cc: Ezequiel Garcia <ezequiel@collabora.com> --- drivers/staging/media/hantro/hantro.h | 3 ++- drivers/staging/media/hantro/hantro_hw.h | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-)