All of lore.kernel.org
 help / color / mirror / Atom feed
From: Hans Verkuil <hverkuil-cisco@xs4all.nl>
To: linux-media@vger.kernel.org
Cc: Hans Verkuil <hverkuil-cisco@xs4all.nl>,
	Ezequiel Garcia <ezequiel@collabora.com>
Subject: [PATCH 07/13] staging: media: hantro: fix kernel-doc formatting
Date: Thu, 11 Mar 2021 11:20:16 +0100	[thread overview]
Message-ID: <20210311102022.96954-8-hverkuil-cisco@xs4all.nl> (raw)
In-Reply-To: <20210311102022.96954-1-hverkuil-cisco@xs4all.nl>

- @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(-)

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


  parent reply	other threads:[~2021-03-11 10:21 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
2021-03-11 10:20 ` [PATCH 01/13] exynos-gsc/exynos4-is: add missing 'struct' to kerneldoc Hans Verkuil
2021-03-11 10:20 ` [PATCH 02/13] s5p-jpeg: fix kernel-doc warnings Hans Verkuil
2021-03-11 10:20 ` [PATCH 03/13] ti-vpe/cal.h: fix kernel-doc formatting Hans Verkuil
2021-03-16 15:03   ` Tomi Valkeinen
2021-03-11 10:20 ` [PATCH 04/13] rcar-vin/rcar-vin.h: " Hans Verkuil
2021-03-11 12:12   ` Niklas Söderlund
2021-03-11 10:20 ` [PATCH 05/13] media/platform/sti: " Hans Verkuil
2021-03-11 10:20 ` [PATCH 06/13] vsp1/vsp1_drm.h: add missing 'struct' kernel-doc keyword Hans Verkuil
2021-03-11 12:12   ` Laurent Pinchart
2021-03-11 12:35     ` Hans Verkuil
2021-03-11 10:20 ` Hans Verkuil [this message]
2021-03-11 14:19   ` [PATCH 07/13] staging: media: hantro: fix kernel-doc formatting Ezequiel Garcia
2021-03-11 10:20 ` [PATCH 08/13] staging: media: ipu3: add missing kernel-doc 'struct' keywords Hans Verkuil
2021-03-11 10:20 ` [PATCH 09/13] staging: media: meson: vdec: fix kernel-doc warning Hans Verkuil
2021-03-11 10:20 ` [PATCH 10/13] mtk-jpeg/mtk_jpeg_core.h: fix kernel-doc warnings Hans Verkuil
2021-03-11 10:20 ` [PATCH 11/13] mtk-mdp: " Hans Verkuil
2021-03-11 10:20 ` [PATCH 12/13] mtk-vcodec: " Hans Verkuil
2021-03-11 10:20 ` [PATCH 13/13] mtk-vpu/mtk_vpu.h: " Hans Verkuil

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=20210311102022.96954-8-hverkuil-cisco@xs4all.nl \
    --to=hverkuil-cisco@xs4all.nl \
    --cc=ezequiel@collabora.com \
    --cc=linux-media@vger.kernel.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.