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>,
Hans Verkuil <hverkuil@xs4all.nl>
Subject: [PATCH 03/22] media: tw68: fix kernel-doc markups
Date: Wed, 29 Nov 2017 14:08:21 -0500 [thread overview]
Message-ID: <bbea65fccf2c5d12624aeba3edbc79337f0d13fd.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 a few mistakes on the existing markups:
drivers/media/pci/tw68/tw68-risc.c:32: warning: Cannot understand * @rp pointer to current risc program position
on line 32 - I thought it was a doc line
drivers/media/pci/tw68/tw68-risc.c:144: warning: No description found for parameter 'pci'
drivers/media/pci/tw68/tw68-risc.c:144: warning: No description found for parameter 'buf'
drivers/media/pci/tw68/tw68-risc.c:144: warning: No description found for parameter 'sglist'
drivers/media/pci/tw68/tw68-risc.c:144: warning: No description found for parameter 'top_offset'
drivers/media/pci/tw68/tw68-risc.c:144: warning: No description found for parameter 'bottom_offset'
drivers/media/pci/tw68/tw68-risc.c:144: warning: No description found for parameter 'bpl'
drivers/media/pci/tw68/tw68-risc.c:144: warning: No description found for parameter 'padding'
drivers/media/pci/tw68/tw68-risc.c:144: warning: No description found for parameter 'lines'
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
drivers/media/pci/tw68/tw68-risc.c | 33 +++++++++++++++++----------------
1 file changed, 17 insertions(+), 16 deletions(-)
diff --git a/drivers/media/pci/tw68/tw68-risc.c b/drivers/media/pci/tw68/tw68-risc.c
index 7439db212a69..82ff9c9494f3 100644
--- a/drivers/media/pci/tw68/tw68-risc.c
+++ b/drivers/media/pci/tw68/tw68-risc.c
@@ -29,14 +29,15 @@
#include "tw68.h"
/**
- * @rp pointer to current risc program position
- * @sglist pointer to "scatter-gather list" of buffer pointers
- * @offset offset to target memory buffer
- * @sync_line 0 -> no sync, 1 -> odd sync, 2 -> even sync
- * @bpl number of bytes per scan line
- * @padding number of bytes of padding to add
- * @lines number of lines in field
- * @jump insert a jump at the start
+ * tw68_risc_field
+ * @rp: pointer to current risc program position
+ * @sglist: pointer to "scatter-gather list" of buffer pointers
+ * @offset: offset to target memory buffer
+ * @sync_line: 0 -> no sync, 1 -> odd sync, 2 -> even sync
+ * @bpl: number of bytes per scan line
+ * @padding: number of bytes of padding to add
+ * @lines: number of lines in field
+ * @jump: insert a jump at the start
*/
static __le32 *tw68_risc_field(__le32 *rp, struct scatterlist *sglist,
unsigned int offset, u32 sync_line,
@@ -120,18 +121,18 @@ static __le32 *tw68_risc_field(__le32 *rp, struct scatterlist *sglist,
* memory for the dma controller "program" and then fills in that
* memory with the appropriate "instructions".
*
- * @pci_dev structure with info about the pci
+ * @pci: structure with info about the pci
* slot which our device is in.
- * @risc structure with info about the memory
+ * @buf: structure with info about the memory
* used for our controller program.
- * @sglist scatter-gather list entry
- * @top_offset offset within the risc program area for the
+ * @sglist: scatter-gather list entry
+ * @top_offset: offset within the risc program area for the
* first odd frame line
- * @bottom_offset offset within the risc program area for the
+ * @bottom_offset: offset within the risc program area for the
* first even frame line
- * @bpl number of data bytes per scan line
- * @padding number of extra bytes to add at end of line
- * @lines number of scan lines
+ * @bpl: number of data bytes per scan line
+ * @padding: number of extra bytes to add at end of line
+ * @lines: number of scan lines
*/
int tw68_risc_buffer(struct pci_dev *pci,
struct tw68_buf *buf,
--
2.14.3
next prev 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 ` Mauro Carvalho Chehab [this message]
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 ` [PATCH 09/22] media: tvp514x: fix kernel-doc parameters Mauro Carvalho Chehab
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=bbea65fccf2c5d12624aeba3edbc79337f0d13fd.1511982439.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=hverkuil@xs4all.nl \
--cc=linux-media@vger.kernel.org \
--cc=mchehab@infradead.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 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).