Re: [PATCH 22/24] media: vb2: add cross references at memops and v4l2 kernel-doc markups

[Sakari Ailus]

On Mon, Oct 09, 2017 at 07:19:28AM -0300, Mauro Carvalho Chehab wrote:
> Add cross-references where needed and add periods at the end of
> each kernel-doc paragraph, in order to make it coherent with other
> VB2 descriptions.
> 
> Signed-off-by: Mauro Carvalho Chehab 

Acked-by: Sakari Ailus 

-- 
Sakari Ailus
e-mail: sakari.ai...@iki.fi
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH 22/24] media: vb2: add cross references at memops and v4l2 kernel-doc markups

[Mauro Carvalho Chehab]

Add cross-references where needed and add periods at the end of
each kernel-doc paragraph, in order to make it coherent with other
VB2 descriptions.

Signed-off-by: Mauro Carvalho Chehab 
---
 include/media/videobuf2-memops.h |   8 +--
 include/media/videobuf2-v4l2.h   | 112 +--
 2 files changed, 63 insertions(+), 57 deletions(-)

diff --git a/include/media/videobuf2-memops.h b/include/media/videobuf2-memops.h
index a6ed091b79ce..4b5b84f93538 100644
--- a/include/media/videobuf2-memops.h
+++ b/include/media/videobuf2-memops.h
@@ -19,11 +19,11 @@
 #include 
 
 /**
- * struct vb2_vmarea_handler - common vma refcount tracking handler
+ * struct vb2_vmarea_handler - common vma refcount tracking handler.
  *
- * @refcount:  pointer to refcount entry in the buffer
- * @put:   callback to function that decreases buffer refcount
- * @arg:   argument for @put callback
+ * @refcount:  pointer to _t entry in the buffer.
+ * @put:   callback to function that decreases buffer refcount.
+ * @arg:   argument for @put callback.
  */
 struct vb2_vmarea_handler {
refcount_t  *refcount;
diff --git a/include/media/videobuf2-v4l2.h b/include/media/videobuf2-v4l2.h
index 036127c54bbf..d38829a9dab3 100644
--- a/include/media/videobuf2-v4l2.h
+++ b/include/media/videobuf2-v4l2.h
@@ -24,16 +24,17 @@
 #endif
 
 /**
- * struct vb2_v4l2_buffer - video buffer information for v4l2
+ * struct vb2_v4l2_buffer - video buffer information for v4l2.
  *
- * @vb2_buf:   video buffer 2
- * @flags: buffer informational flags
- * @field: enum v4l2_field; field order of the image in the buffer
- * @timecode:  frame timecode
- * @sequence:  sequence count of this frame
+ * @vb2_buf:   embedded struct _buffer.
+ * @flags: buffer informational flags.
+ * @field: field order of the image in the buffer, as defined by
+ *  v4l2_field.
+ * @timecode:  frame timecode.
+ * @sequence:  sequence count of this frame.
  *
  * Should contain enough information to be able to cover all the fields
- * of struct v4l2_buffer at videodev2.h
+ * of  v4l2_buffer at ``videodev2.h``.
  */
 struct vb2_v4l2_buffer {
struct vb2_buffer   vb2_buf;
@@ -56,9 +57,9 @@ int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b);
  * vb2_reqbufs() - Wrapper for vb2_core_reqbufs() that also verifies
  * the memory and type values.
  *
- * @q: videobuf2 queue
- * @req:   struct passed from userspace to vidioc_reqbufs handler
- * in driver
+ * @q: pointer to  vb2_queue with videobuf2 queue.
+ * @req:v4l2_requestbuffers passed from userspace to
+ * _ioctl_ops->vidioc_reqbufs handler in driver.
  */
 int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req);
 
@@ -66,94 +67,99 @@ int vb2_reqbufs(struct vb2_queue *q, struct 
v4l2_requestbuffers *req);
  * vb2_create_bufs() - Wrapper for vb2_core_create_bufs() that also verifies
  * the memory and type values.
  *
- * @q: videobuf2 queue
- * @create:creation parameters, passed from userspace to vidioc_create_bufs
- * handler in driver
+ * @q: pointer to  vb2_queue with videobuf2 queue.
+ * @create:creation parameters, passed from userspace to
+ * _ioctl_ops->vidioc_create_bufs handler in driver
  */
 int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create);
 
 /**
  * vb2_prepare_buf() - Pass ownership of a buffer from userspace to the kernel
  *
- * @q: videobuf2 queue
- * @b: buffer structure passed from userspace to vidioc_prepare_buf
- * handler in driver
+ * @q: pointer to  vb2_queue with videobuf2 queue.
+ * @b: buffer structure passed from userspace to
+ * _ioctl_ops->vidioc_prepare_buf handler in driver
+ *
+ * Should be called from _ioctl_ops->vidioc_prepare_buf ioctl handler
+ * of a driver.
  *
- * Should be called from vidioc_prepare_buf ioctl handler of a driver.
  * This function:
  *
  * #) verifies the passed buffer,
- * #) calls buf_prepare callback in the driver (if provided), in which
- *driver-specific buffer initialization can be performed.
+ * #) calls _ops->buf_prepare callback in the driver (if provided),
+ *in which driver-specific buffer initialization can be performed.
  *
  * The return values from this function are intended to be directly returned
- * from vidioc_prepare_buf handler in driver.
+ * from _ioctl_ops->vidioc_prepare_buf handler in driver.
  */
 int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b);
 
 /**
  * vb2_qbuf() - Queue a buffer from userspace
- * @q: videobuf2 queue
- * @b: buffer structure passed from userspace to VIDIOC_QBUF() handler
- * in driver
+ * @q: pointer to  vb2_queue with videobuf2 queue.
+ * @b: buffer structure passed from userspace to
+ * _ioctl_ops->vidioc_qbuf handler in