Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

media: davinci: fix kernel-doc warnings

There are several of kernel-doc warnings:

drivers/media/platform/davinci/vpif_display.c:114: warning: No description found for parameter 'sizes'
drivers/media/platform/davinci/vpif_display.c:165: warning: No description found for parameter 'vq'
drivers/media/platform/davinci/vpif_display.c:165: warning: Excess function parameter 'vb' description in 'vpif_start_streaming'
drivers/media/platform/davinci/vpif_display.c:780: warning: No description found for parameter 'vpif_cfg'
drivers/media/platform/davinci/vpif_display.c:780: warning: No description found for parameter 'chan_cfg'
drivers/media/platform/davinci/vpif_display.c:780: warning: No description found for parameter 'index'
drivers/media/platform/davinci/vpif_display.c:813: warning: No description found for parameter 'vpif_cfg'
drivers/media/platform/davinci/vpif_display.c:813: warning: No description found for parameter 'ch'
drivers/media/platform/davinci/vpif_display.c:813: warning: No description found for parameter 'index'
drivers/media/platform/davinci/vpif_capture.c:121: warning: No description found for parameter 'sizes'
drivers/media/platform/davinci/vpif_capture.c:174: warning: No description found for parameter 'vq'
drivers/media/platform/davinci/vpif_capture.c:174: warning: Excess function parameter 'vb' description in 'vpif_start_streaming'
drivers/media/platform/davinci/vpif_capture.c:636: warning: No description found for parameter 'iface'
drivers/media/platform/davinci/vpif_capture.c:647: warning: No description found for parameter 'ch'
drivers/media/platform/davinci/vpif_capture.c:647: warning: No description found for parameter 'muxmode'
drivers/media/platform/davinci/vpif_capture.c:676: warning: No description found for parameter 'vpif_cfg'
drivers/media/platform/davinci/vpif_capture.c:676: warning: No description found for parameter 'chan_cfg'
drivers/media/platform/davinci/vpif_capture.c:676: warning: No description found for parameter 'input_index'
drivers/media/platform/davinci/vpif_capture.c:712: warning: No description found for parameter 'vpif_cfg'
drivers/media/platform/davinci/vpif_capture.c:712: warning: No description found for parameter 'ch'
drivers/media/platform/davinci/vpif_capture.c:712: warning: No description found for parameter 'index'
drivers/media/platform/davinci/vpif_capture.c:798: warning: No description found for parameter 'std'
drivers/media/platform/davinci/vpif_capture.c:798: warning: Excess function parameter 'std_id' description in 'vpif_g_std'
drivers/media/platform/davinci/vpif_capture.c:940: warning: No description found for parameter 'fmt'
drivers/media/platform/davinci/vpif_capture.c:940: warning: Excess function parameter 'index' description in 'vpif_enum_fmt_vid_cap'
drivers/media/platform/davinci/vpif_capture.c:1750: warning: No description found for parameter 'dev'

Fix them.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

+22 -21
+14 -13
drivers/media/platform/davinci/vpif_capture.c
··· 109 109 * @vq: vb2_queue ptr 110 110 * @nbuffers: ptr to number of buffers requested by application 111 111 * @nplanes:: contains number of distinct video planes needed to hold a frame 112 - * @sizes[]: contains the size (in bytes) of each plane. 112 + * @sizes: contains the size (in bytes) of each plane. 113 113 * @alloc_devs: ptr to allocation context 114 114 * 115 115 * This callback function is called when reqbuf() is called to adjust ··· 167 167 168 168 /** 169 169 * vpif_start_streaming : Starts the DMA engine for streaming 170 - * @vb: ptr to vb2_buffer 170 + * @vq: ptr to vb2_buffer 171 171 * @count: number of buffers 172 172 */ 173 173 static int vpif_start_streaming(struct vb2_queue *vq, unsigned int count) ··· 629 629 630 630 /** 631 631 * vpif_get_default_field() - Get default field type based on interface 632 - * @vpif_params - ptr to vpif params 632 + * @iface: ptr to vpif interface 633 633 */ 634 634 static inline enum v4l2_field vpif_get_default_field( 635 635 struct vpif_interface *iface) ··· 640 640 641 641 /** 642 642 * vpif_config_addr() - function to configure buffer address in vpif 643 - * @ch - channel ptr 644 - * @muxmode - channel mux mode 643 + * @ch: channel ptr 644 + * @muxmode: channel mux mode 645 645 */ 646 646 static void vpif_config_addr(struct channel_obj *ch, int muxmode) 647 647 { ··· 661 661 662 662 /** 663 663 * vpif_input_to_subdev() - Maps input to sub device 664 - * @vpif_cfg - global config ptr 665 - * @chan_cfg - channel config ptr 666 - * @input_index - Given input index from application 664 + * @vpif_cfg: global config ptr 665 + * @chan_cfg: channel config ptr 666 + * @input_index: Given input index from application 667 667 * 668 668 * lookup the sub device information for a given input index. 669 669 * we report all the inputs to application. inputs table also ··· 699 699 700 700 /** 701 701 * vpif_set_input() - Select an input 702 - * @vpif_cfg - global config ptr 703 - * @ch - channel 704 - * @_index - Given input index from application 702 + * @vpif_cfg: global config ptr 703 + * @ch: channel 704 + * @index: Given input index from application 705 705 * 706 706 * Select the given input. 707 707 */ ··· 792 792 * vpif_g_std() - get STD handler 793 793 * @file: file ptr 794 794 * @priv: file handle 795 - * @std_id: ptr to std id 795 + * @std: ptr to std id 796 796 */ 797 797 static int vpif_g_std(struct file *file, void *priv, v4l2_std_id *std) 798 798 { ··· 933 933 * vpif_enum_fmt_vid_cap() - ENUM_FMT handler 934 934 * @file: file ptr 935 935 * @priv: file handle 936 - * @index: input index 936 + * @fmt: ptr to V4L2 format descriptor 937 937 */ 938 938 static int vpif_enum_fmt_vid_cap(struct file *file, void *priv, 939 939 struct v4l2_fmtdesc *fmt) ··· 1745 1745 #ifdef CONFIG_PM_SLEEP 1746 1746 /** 1747 1747 * vpif_suspend: vpif device suspend 1748 + * @dev: pointer to &struct device 1748 1749 */ 1749 1750 static int vpif_suspend(struct device *dev) 1750 1751 {
+8 -8
drivers/media/platform/davinci/vpif_display.c
··· 102 102 * @vq: vb2_queue ptr 103 103 * @nbuffers: ptr to number of buffers requested by application 104 104 * @nplanes:: contains number of distinct video planes needed to hold a frame 105 - * @sizes[]: contains the size (in bytes) of each plane. 105 + * @sizes: contains the size (in bytes) of each plane. 106 106 * @alloc_devs: ptr to allocation context 107 107 * 108 108 * This callback function is called when reqbuf() is called to adjust ··· 158 158 159 159 /** 160 160 * vpif_start_streaming : Starts the DMA engine for streaming 161 - * @vb: ptr to vb2_buffer 161 + * @vq: ptr to vb2_buffer 162 162 * @count: number of buffers 163 163 */ 164 164 static int vpif_start_streaming(struct vb2_queue *vq, unsigned int count) ··· 766 766 767 767 /** 768 768 * vpif_output_to_subdev() - Maps output to sub device 769 - * @vpif_cfg - global config ptr 770 - * @chan_cfg - channel config ptr 771 - * @index - Given output index from application 769 + * @vpif_cfg: global config ptr 770 + * @chan_cfg: channel config ptr 771 + * @index: Given output index from application 772 772 * 773 773 * lookup the sub device information for a given output index. 774 774 * we report all the output to application. output table also ··· 802 802 803 803 /** 804 804 * vpif_set_output() - Select an output 805 - * @vpif_cfg - global config ptr 806 - * @ch - channel 807 - * @index - Given output index from application 805 + * @vpif_cfg: global config ptr 806 + * @ch: channel 807 + * @index: Given output index from application 808 808 * 809 809 * Select the given output. 810 810 */