linux-media.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: unlisted-recipients:; (no To-header on input)@bombadil.infradead.org
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Linux Media Mailing List <linux-media@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	Sakari Ailus <sakari.ailus@linux.intel.com>,
	Benoit Parrot <bparrot@ti.com>
Subject: [PATCH 09/22] media: tvp514x: fix kernel-doc parameters
Date: Wed, 29 Nov 2017 14:08:27 -0500	[thread overview]
Message-ID: <ca292c88e954f0f49029445bfef57364dff705db.1511982439.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <73497577f67fbb917e40ab4328104ff310a7c356.1511982439.git.mchehab@s-opensource.com>
In-Reply-To: <73497577f67fbb917e40ab4328104ff310a7c356.1511982439.git.mchehab@s-opensource.com>

There are some struct fields that aren't documented, and some
consts whose comments start with /**, but they aren't kernel-doc
annotations. So, fix it:

  drivers/media/i2c/tvp514x.c:127: warning: No description found for parameter 'hdl'
  drivers/media/i2c/tvp514x.c:127: warning: No description found for parameter 'pad'
  drivers/media/i2c/tvp514x.c:127: warning: No description found for parameter 'format'
  drivers/media/i2c/tvp514x.c:127: warning: No description found for parameter 'int_seq'
  drivers/media/i2c/tvp514x.c:219: warning: cannot understand function prototype: 'const struct v4l2_fmtdesc tvp514x_fmt_list[] = '
  drivers/media/i2c/tvp514x.c:235: warning: cannot understand function prototype: 'const struct tvp514x_std_info tvp514x_std_list[] = '
  drivers/media/i2c/tvp514x.c:941: warning: No description found for parameter 'fmt'
  drivers/media/i2c/tvp514x.c:941: warning: Excess function parameter 'format' description in 'tvp514x_set_pad_format'
  drivers/media/i2c/tvp514x.c:1208: warning: cannot understand function prototype: 'const struct i2c_device_id tvp514x_id[] = '

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 drivers/media/i2c/tvp514x.c | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/drivers/media/i2c/tvp514x.c b/drivers/media/i2c/tvp514x.c
index ad2df998f9c5..d575b3e7e835 100644
--- a/drivers/media/i2c/tvp514x.c
+++ b/drivers/media/i2c/tvp514x.c
@@ -86,6 +86,7 @@ static int tvp514x_s_stream(struct v4l2_subdev *sd, int enable);
 /**
  * struct tvp514x_decoder - TVP5146/47 decoder object
  * @sd: Subdevice Slave handle
+ * @hdl: embedded &struct v4l2_ctrl_handler
  * @tvp514x_regs: copy of hw's regs with preset values.
  * @pdata: Board specific
  * @ver: Chip version
@@ -98,6 +99,9 @@ static int tvp514x_s_stream(struct v4l2_subdev *sd, int enable);
  * @std_list: Standards list
  * @input: Input routing at chip level
  * @output: Output routing at chip level
+ * @pad: subdev media pad associated with the decoder
+ * @format: media bus frame format
+ * @int_seq: driver's register init sequence
  */
 struct tvp514x_decoder {
 	struct v4l2_subdev sd;
@@ -211,7 +215,7 @@ static struct tvp514x_reg tvp514x_reg_list_default[] = {
 	{TOK_TERM, 0, 0},
 };
 
-/**
+/*
  * List of image formats supported by TVP5146/47 decoder
  * Currently we are using 8 bit mode only, but can be
  * extended to 10/20 bit mode.
@@ -226,7 +230,7 @@ static const struct v4l2_fmtdesc tvp514x_fmt_list[] = {
 	},
 };
 
-/**
+/*
  * Supported standards -
  *
  * Currently supports two standards only, need to add support for rest of the
@@ -931,7 +935,7 @@ static int tvp514x_get_pad_format(struct v4l2_subdev *sd,
  * tvp514x_set_pad_format() - V4L2 decoder interface handler for set pad format
  * @sd: pointer to standard V4L2 sub-device structure
  * @cfg: pad configuration
- * @format: pointer to v4l2_subdev_format structure
+ * @fmt: pointer to v4l2_subdev_format structure
  *
  * Set pad format for the output pad
  */
@@ -1199,7 +1203,7 @@ static const struct tvp514x_reg tvp514xm_init_reg_seq[] = {
 	{TOK_TERM, 0, 0},
 };
 
-/**
+/*
  * I2C Device Table -
  *
  * name - Name of the actual device/chip.
-- 
2.14.3

  parent reply	other threads:[~2017-11-29 19:08 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-29 19:08 [PATCH 01/22] media: sta2x11: document missing function parameters Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 02/22] media: pxa_camera: get rid of kernel_doc warnings Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 03/22] media: tw68: fix kernel-doc markups Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 04/22] media: ix2505v: get rid of /** comments Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 05/22] media: radio-si476x: fix kernel-doc markups Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 06/22] media: s5k6a3: document some fields at struct s5k6a3 Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 07/22] media: s5k6aa: describe some function parameters Mauro Carvalho Chehab
2017-11-30 19:17   ` Nicholas Mc Guire
2017-11-29 19:08 ` [PATCH 08/22] media: netup_unidvb: fix a bad kernel-doc markup Mauro Carvalho Chehab
2017-11-29 19:08 ` Mauro Carvalho Chehab [this message]
2017-11-29 19:08 ` [PATCH 10/22] media: vdec: fix some kernel-doc warnings Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 11/22] media: mtk-vpu: add description for wdt fields at struct mtk_vpu Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 12/22] media: s3c-camif: add missing description at s3c_camif_find_format() Mauro Carvalho Chehab
     [not found]   ` <CGME20171130095946epcas2p47a595044e5f5328db0b5a8a17e8888e2@epcas2p4.samsung.com>
2017-11-30  9:59     ` Sylwester Nawrocki
2017-11-29 19:08 ` [PATCH 13/22] media: radio-wl1273: fix a parameter name at kernel-doc macro Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 14/22] media: mt2063: fix some kernel-doc warnings Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 15/22] media: soc_camera: fix a kernel-doc markup Mauro Carvalho Chehab
2017-11-30  7:33   ` Guennadi Liakhovetski
2017-11-29 19:08 ` [PATCH 16/22] media: vsp1: add a missing kernel-doc parameter Mauro Carvalho Chehab
2017-11-30  9:32   ` Kieran Bingham
2017-11-29 19:08 ` [PATCH 17/22] media: rcar_jpu: fix two kernel-doc markups Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 18/22] media: lm3560: add a missing kernel-doc parameter Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 19/22] media: drivers: remove "/**" from non-kernel-doc comments Mauro Carvalho Chehab
2017-11-30  9:30   ` Kieran Bingham
2017-11-29 19:08 ` [PATCH 20/22] media: dvb_frontends: fix kernel-doc macros Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 21/22] media: docs: add documentation for frontend attach info Mauro Carvalho Chehab
2017-11-29 19:08 ` [PATCH 22/22] media: dvb-frontends: complete kernel-doc markups Mauro Carvalho Chehab

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=ca292c88e954f0f49029445bfef57364dff705db.1511982439.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=bparrot@ti.com \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@infradead.org \
    --cc=sakari.ailus@linux.intel.com \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).