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

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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 1855e988
...@@ -239,7 +239,7 @@ static const struct analog_demod_ops tuner_analog_ops = { ...@@ -239,7 +239,7 @@ static const struct analog_demod_ops tuner_analog_ops = {
* @type: type of the tuner (e. g. tuner number) * @type: type of the tuner (e. g. tuner number)
* @new_mode_mask: Indicates if tuner supports TV and/or Radio * @new_mode_mask: Indicates if tuner supports TV and/or Radio
* @new_config: an optional parameter used by a few tuners to adjust * @new_config: an optional parameter used by a few tuners to adjust
internal parameters, like LNA mode * internal parameters, like LNA mode
* @tuner_callback: an optional function to be called when switching * @tuner_callback: an optional function to be called when switching
* to analog mode * to analog mode
* *
...@@ -750,6 +750,7 @@ static int tuner_remove(struct i2c_client *client) ...@@ -750,6 +750,7 @@ static int tuner_remove(struct i2c_client *client)
/** /**
* check_mode - Verify if tuner supports the requested mode * check_mode - Verify if tuner supports the requested mode
* @t: a pointer to the module's internal struct_tuner * @t: a pointer to the module's internal struct_tuner
* @mode: mode of the tuner, as defined by &enum v4l2_tuner_type.
* *
* This function checks if the tuner is capable of tuning analog TV, * This function checks if the tuner is capable of tuning analog TV,
* digital TV or radio, depending on what the caller wants. If the * digital TV or radio, depending on what the caller wants. If the
...@@ -757,6 +758,7 @@ static int tuner_remove(struct i2c_client *client) ...@@ -757,6 +758,7 @@ static int tuner_remove(struct i2c_client *client)
* returns 0. * returns 0.
* This function is needed for boards that have a separate tuner for * This function is needed for boards that have a separate tuner for
* radio (like devices with tea5767). * radio (like devices with tea5767).
*
* NOTE: mt20xx uses V4L2_TUNER_DIGITAL_TV and calls set_tv_freq to * NOTE: mt20xx uses V4L2_TUNER_DIGITAL_TV and calls set_tv_freq to
* select a TV frequency. So, t_mode = T_ANALOG_TV could actually * select a TV frequency. So, t_mode = T_ANALOG_TV could actually
* be used to represent a Digital TV too. * be used to represent a Digital TV too.
......
...@@ -245,11 +245,11 @@ EXPORT_SYMBOL_GPL(v4l2_find_dv_timings_cea861_vic); ...@@ -245,11 +245,11 @@ EXPORT_SYMBOL_GPL(v4l2_find_dv_timings_cea861_vic);
/** /**
* v4l2_match_dv_timings - check if two timings match * v4l2_match_dv_timings - check if two timings match
* @t1 - compare this v4l2_dv_timings struct... * @t1: compare this v4l2_dv_timings struct...
* @t2 - with this struct. * @t2: with this struct.
* @pclock_delta - the allowed pixelclock deviation. * @pclock_delta: the allowed pixelclock deviation.
* @match_reduced_fps - if true, then fail if V4L2_DV_FL_REDUCED_FPS does not * @match_reduced_fps: if true, then fail if V4L2_DV_FL_REDUCED_FPS does not
* match. * match.
* *
* Compare t1 with t2 with a given margin of error for the pixelclock. * Compare t1 with t2 with a given margin of error for the pixelclock.
*/ */
......
...@@ -183,6 +183,7 @@ EXPORT_SYMBOL(v4l2_m2m_get_curr_priv); ...@@ -183,6 +183,7 @@ EXPORT_SYMBOL(v4l2_m2m_get_curr_priv);
/** /**
* v4l2_m2m_try_run() - select next job to perform and run it if possible * v4l2_m2m_try_run() - select next job to perform and run it if possible
* @m2m_dev: per-device context
* *
* Get next transaction (if present) from the waiting jobs list and run it. * Get next transaction (if present) from the waiting jobs list and run it.
*/ */
...@@ -281,6 +282,7 @@ EXPORT_SYMBOL_GPL(v4l2_m2m_try_schedule); ...@@ -281,6 +282,7 @@ EXPORT_SYMBOL_GPL(v4l2_m2m_try_schedule);
/** /**
* v4l2_m2m_cancel_job() - cancel pending jobs for the context * v4l2_m2m_cancel_job() - cancel pending jobs for the context
* @m2m_ctx: m2m context with jobs to be canceled
* *
* In case of streamoff or release called on any context, * In case of streamoff or release called on any context,
* 1] If the context is currently running, then abort job will be called * 1] If the context is currently running, then abort job will be called
......
...@@ -222,7 +222,7 @@ int videobuf_queue_is_busy(struct videobuf_queue *q) ...@@ -222,7 +222,7 @@ int videobuf_queue_is_busy(struct videobuf_queue *q)
} }
EXPORT_SYMBOL_GPL(videobuf_queue_is_busy); EXPORT_SYMBOL_GPL(videobuf_queue_is_busy);
/** /*
* __videobuf_free() - free all the buffers and their control structures * __videobuf_free() - free all the buffers and their control structures
* *
* This function can only be called if streaming/reading is off, i.e. no buffers * This function can only be called if streaming/reading is off, i.e. no buffers
......
...@@ -120,7 +120,7 @@ static void vb2_common_vm_close(struct vm_area_struct *vma) ...@@ -120,7 +120,7 @@ static void vb2_common_vm_close(struct vm_area_struct *vma)
h->put(h->arg); h->put(h->arg);
} }
/** /*
* vb2_common_vm_ops - common vm_ops used for tracking refcount of mmaped * vb2_common_vm_ops - common vm_ops used for tracking refcount of mmaped
* video buffers * video buffers
*/ */
......
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