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

media: v4l2-core: Fix kernel-doc markups

There are some troubles on kernel-doc markups, as warned:

drivers/media/v4l2-core/v4l2-dv-timings.c:259: warning: No description found for parameter 't1'
drivers/media/v4l2-core/v4l2-dv-timings.c:259: warning: No description found for parameter 't2'
drivers/media/v4l2-core/v4l2-dv-timings.c:259: warning: No description found for parameter 'pclock_delta'
drivers/media/v4l2-core/v4l2-dv-timings.c:259: warning: No description found for parameter 'match_reduced_fps'
drivers/media/v4l2-core/tuner-core.c:242: warning: bad line: internal parameters, like LNA mode
drivers/media/v4l2-core/tuner-core.c:765: warning: No description found for parameter 'mode'
drivers/media/v4l2-core/videobuf2-memops.c:127: warning: cannot understand function prototype: 'const struct vm_operations_struct vb2_common_vm_ops = '
drivers/media/v4l2-core/v4l2-mem2mem.c:190: warning: No description found for parameter 'm2m_dev'
drivers/media/v4l2-core/v4l2-mem2mem.c:291: warning: No description found for parameter 'm2m_ctx'
drivers/media/v4l2-core/videobuf-core.c:233: warning: No description found for parameter 'q'

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

+12 -8
+3 -1
drivers/media/v4l2-core/tuner-core.c
··· 239 239 * @type: type of the tuner (e. g. tuner number) 240 240 * @new_mode_mask: Indicates if tuner supports TV and/or Radio 241 241 * @new_config: an optional parameter used by a few tuners to adjust 242 - internal parameters, like LNA mode 242 + * internal parameters, like LNA mode 243 243 * @tuner_callback: an optional function to be called when switching 244 244 * to analog mode 245 245 * ··· 750 750 /** 751 751 * check_mode - Verify if tuner supports the requested mode 752 752 * @t: a pointer to the module's internal struct_tuner 753 + * @mode: mode of the tuner, as defined by &enum v4l2_tuner_type. 753 754 * 754 755 * This function checks if the tuner is capable of tuning analog TV, 755 756 * digital TV or radio, depending on what the caller wants. If the ··· 758 757 * returns 0. 759 758 * This function is needed for boards that have a separate tuner for 760 759 * radio (like devices with tea5767). 760 + * 761 761 * NOTE: mt20xx uses V4L2_TUNER_DIGITAL_TV and calls set_tv_freq to 762 762 * select a TV frequency. So, t_mode = T_ANALOG_TV could actually 763 763 * be used to represent a Digital TV too.
+5 -5
drivers/media/v4l2-core/v4l2-dv-timings.c
··· 245 245 246 246 /** 247 247 * v4l2_match_dv_timings - check if two timings match 248 - * @t1 - compare this v4l2_dv_timings struct... 249 - * @t2 - with this struct. 250 - * @pclock_delta - the allowed pixelclock deviation. 251 - * @match_reduced_fps - if true, then fail if V4L2_DV_FL_REDUCED_FPS does not 252 - * match. 248 + * @t1: compare this v4l2_dv_timings struct... 249 + * @t2: with this struct. 250 + * @pclock_delta: the allowed pixelclock deviation. 251 + * @match_reduced_fps: if true, then fail if V4L2_DV_FL_REDUCED_FPS does not 252 + * match. 253 253 * 254 254 * Compare t1 with t2 with a given margin of error for the pixelclock. 255 255 */
+2
drivers/media/v4l2-core/v4l2-mem2mem.c
··· 183 183 184 184 /** 185 185 * v4l2_m2m_try_run() - select next job to perform and run it if possible 186 + * @m2m_dev: per-device context 186 187 * 187 188 * Get next transaction (if present) from the waiting jobs list and run it. 188 189 */ ··· 282 281 283 282 /** 284 283 * v4l2_m2m_cancel_job() - cancel pending jobs for the context 284 + * @m2m_ctx: m2m context with jobs to be canceled 285 285 * 286 286 * In case of streamoff or release called on any context, 287 287 * 1] If the context is currently running, then abort job will be called
+1 -1
drivers/media/v4l2-core/videobuf-core.c
··· 222 222 } 223 223 EXPORT_SYMBOL_GPL(videobuf_queue_is_busy); 224 224 225 - /** 225 + /* 226 226 * __videobuf_free() - free all the buffers and their control structures 227 227 * 228 228 * This function can only be called if streaming/reading is off, i.e. no buffers
+1 -1
drivers/media/v4l2-core/videobuf2-memops.c
··· 120 120 h->put(h->arg); 121 121 } 122 122 123 - /** 123 + /* 124 124 * vb2_common_vm_ops - common vm_ops used for tracking refcount of mmaped 125 125 * video buffers 126 126 */