diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-11-29 06:03:52 -0500 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-11-30 04:18:56 -0500 |
| commit | ef69f8d2ff09518657c3ecaf2db8408c16549829 (patch) | |
| tree | 1fcde97ecd1c5f729adae90aa7d07f817b2fe0d2 /drivers | |
| parent | 8fd87479251925dedd6c524bc592541fefde2332 (diff) | |
| download | linux-ef69f8d2ff09518657c3ecaf2db8408c16549829.tar.bz2 | |
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>
Diffstat (limited to 'drivers')
| -rw-r--r-- | drivers/media/pci/tw68/tw68-risc.c | 33 |
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 @@ #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, |