aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2017-11-29 06:03:52 -0500
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2017-11-30 04:18:56 -0500
commitef69f8d2ff09518657c3ecaf2db8408c16549829 (patch)
tree1fcde97ecd1c5f729adae90aa7d07f817b2fe0d2
parent8fd87479251925dedd6c524bc592541fefde2332 (diff)
media: tw68: fix kernel-doc markups
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>
-rw-r--r--drivers/media/pci/tw68/tw68-risc.c33
1 files 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 @@
29#include "tw68.h" 29#include "tw68.h"
30 30
31/** 31/**
32 * @rp pointer to current risc program position 32 * tw68_risc_field
33 * @sglist pointer to "scatter-gather list" of buffer pointers 33 * @rp: pointer to current risc program position
34 * @offset offset to target memory buffer 34 * @sglist: pointer to "scatter-gather list" of buffer pointers
35 * @sync_line 0 -> no sync, 1 -> odd sync, 2 -> even sync 35 * @offset: offset to target memory buffer
36 * @bpl number of bytes per scan line 36 * @sync_line: 0 -> no sync, 1 -> odd sync, 2 -> even sync
37 * @padding number of bytes of padding to add 37 * @bpl: number of bytes per scan line
38 * @lines number of lines in field 38 * @padding: number of bytes of padding to add
39 * @jump insert a jump at the start 39 * @lines: number of lines in field
40 * @jump: insert a jump at the start
40 */ 41 */
41static __le32 *tw68_risc_field(__le32 *rp, struct scatterlist *sglist, 42static __le32 *tw68_risc_field(__le32 *rp, struct scatterlist *sglist,
42 unsigned int offset, u32 sync_line, 43 unsigned int offset, u32 sync_line,
@@ -120,18 +121,18 @@ static __le32 *tw68_risc_field(__le32 *rp, struct scatterlist *sglist,
120 * memory for the dma controller "program" and then fills in that 121 * memory for the dma controller "program" and then fills in that
121 * memory with the appropriate "instructions". 122 * memory with the appropriate "instructions".
122 * 123 *
123 * @pci_dev structure with info about the pci 124 * @pci: structure with info about the pci
124 * slot which our device is in. 125 * slot which our device is in.
125 * @risc structure with info about the memory 126 * @buf: structure with info about the memory
126 * used for our controller program. 127 * used for our controller program.
127 * @sglist scatter-gather list entry 128 * @sglist: scatter-gather list entry
128 * @top_offset offset within the risc program area for the 129 * @top_offset: offset within the risc program area for the
129 * first odd frame line 130 * first odd frame line
130 * @bottom_offset offset within the risc program area for the 131 * @bottom_offset: offset within the risc program area for the
131 * first even frame line 132 * first even frame line
132 * @bpl number of data bytes per scan line 133 * @bpl: number of data bytes per scan line
133 * @padding number of extra bytes to add at end of line 134 * @padding: number of extra bytes to add at end of line
134 * @lines number of scan lines 135 * @lines: number of scan lines
135 */ 136 */
136int tw68_risc_buffer(struct pci_dev *pci, 137int tw68_risc_buffer(struct pci_dev *pci,
137 struct tw68_buf *buf, 138 struct tw68_buf *buf,