Commit ef69f8d2 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 8fd87479
...@@ -29,14 +29,15 @@ ...@@ -29,14 +29,15 @@
#include "tw68.h" #include "tw68.h"
/** /**
* @rp pointer to current risc program position * tw68_risc_field
* @sglist pointer to "scatter-gather list" of buffer pointers * @rp: pointer to current risc program position
* @offset offset to target memory buffer * @sglist: pointer to "scatter-gather list" of buffer pointers
* @sync_line 0 -> no sync, 1 -> odd sync, 2 -> even sync * @offset: offset to target memory buffer
* @bpl number of bytes per scan line * @sync_line: 0 -> no sync, 1 -> odd sync, 2 -> even sync
* @padding number of bytes of padding to add * @bpl: number of bytes per scan line
* @lines number of lines in field * @padding: number of bytes of padding to add
* @jump insert a jump at the start * @lines: number of lines in field
* @jump: insert a jump at the start
*/ */
static __le32 *tw68_risc_field(__le32 *rp, struct scatterlist *sglist, static __le32 *tw68_risc_field(__le32 *rp, struct scatterlist *sglist,
unsigned int offset, u32 sync_line, unsigned int offset, u32 sync_line,
...@@ -120,18 +121,18 @@ static __le32 *tw68_risc_field(__le32 *rp, struct scatterlist *sglist, ...@@ -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 for the dma controller "program" and then fills in that
* memory with the appropriate "instructions". * 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. * 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. * used for our controller program.
* @sglist scatter-gather list entry * @sglist: scatter-gather list entry
* @top_offset offset within the risc program area for the * @top_offset: offset within the risc program area for the
* first odd frame line * 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 * first even frame line
* @bpl number of data bytes per scan line * @bpl: number of data bytes per scan line
* @padding number of extra bytes to add at end of line * @padding: number of extra bytes to add at end of line
* @lines number of scan lines * @lines: number of scan lines
*/ */
int tw68_risc_buffer(struct pci_dev *pci, int tw68_risc_buffer(struct pci_dev *pci,
struct tw68_buf *buf, struct tw68_buf *buf,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment