mirror of
https://github.com/linux-msm/laptops-kernel.git
synced 2026-08-13 14:19:53 -07:00
media: videobuf2: move vb2_querybuf() kernel-doc to header
Move the function documentation for vb2_querybuf() from videobuf2-v4l2.c to videobuf2-v4l2.h to match other functions. Leaving the comment in the source file prevents the kernel-doc parser from extracting it - thus become missing from the generated HTML. Additionally, format the comment block to be the same style as other functions in the header. Signed-off-by: Tharit Tangkijwanichakul <tharitt97@gmail.com> Signed-off-by: Hans Verkuil <hverkuil+cisco@kernel.org>
This commit is contained in:
committed by
Hans Verkuil
parent
3839365cf0
commit
cd05b6174e
@@ -635,19 +635,6 @@ struct vb2_buffer *vb2_find_buffer(struct vb2_queue *q, u64 timestamp)
|
||||
}
|
||||
EXPORT_SYMBOL_GPL(vb2_find_buffer);
|
||||
|
||||
/*
|
||||
* vb2_querybuf() - query video buffer information
|
||||
* @q: vb2 queue
|
||||
* @b: buffer struct passed from userspace to vidioc_querybuf handler
|
||||
* in driver
|
||||
*
|
||||
* Should be called from vidioc_querybuf ioctl handler in driver.
|
||||
* This function will verify the passed v4l2_buffer structure and fill the
|
||||
* relevant information for the userspace.
|
||||
*
|
||||
* The return values from this function are intended to be directly returned
|
||||
* from vidioc_querybuf handler in driver.
|
||||
*/
|
||||
int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b)
|
||||
{
|
||||
struct vb2_buffer *vb;
|
||||
|
||||
@@ -72,6 +72,19 @@ struct vb2_v4l2_buffer {
|
||||
*/
|
||||
struct vb2_buffer *vb2_find_buffer(struct vb2_queue *q, u64 timestamp);
|
||||
|
||||
/**
|
||||
* vb2_querybuf() - Query video buffer information
|
||||
* @q: pointer to &struct vb2_queue with videobuf2 queue.
|
||||
* @b: buffer structure passed from userspace to
|
||||
* &v4l2_ioctl_ops->vidioc_querybuf handler in driver
|
||||
*
|
||||
* Should be called from vidioc_querybuf ioctl handler in driver.
|
||||
* This function will verify the passed v4l2_buffer structure and fill the
|
||||
* relevant information for the userspace.
|
||||
*
|
||||
* The return values from this function are intended to be directly returned
|
||||
* from vidioc_querybuf handler in driver.
|
||||
*/
|
||||
int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b);
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user