From efe98010b80ec4516b2779e1b4e4a8ce16bf89fe Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Mon, 5 Oct 2015 09:12:56 -0300 Subject: [PATCH] [media] DocBook: Fix remaining issues with VB2 core documentation Right now, "private:" tag should be lower-case, otherwise the scripts/kernel-doc won't do the right thing. Also, no fields after "private:" should be documented. As we don't want to strip the documentation, let's untag. This way, it will be seen only at the file, and not at the DocBooks. Signed-off-by: Mauro Carvalho Chehab --- include/media/videobuf2-core.h | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/include/media/videobuf2-core.h b/include/media/videobuf2-core.h index 128b15ad5497..af9a5d177fca 100644 --- a/include/media/videobuf2-core.h +++ b/include/media/videobuf2-core.h @@ -202,11 +202,6 @@ struct vb2_queue; * @num_planes: number of planes in the buffer * on an internal driver queue * @planes: private per-plane information; do not change - * @state: current buffer state; do not change - * @queued_entry: entry on the queued buffers list, which holds all - * buffers queued from userspace - * @done_entry: entry on the list that stores all buffers ready to - * be dequeued to userspace */ struct vb2_buffer { struct vb2_queue *vb2_queue; @@ -216,7 +211,14 @@ struct vb2_buffer { unsigned int num_planes; struct vb2_plane planes[VIDEO_MAX_PLANES]; - /* Private: internal use only */ + /* private: internal use only + * + * state: current buffer state; do not change + * queued_entry: entry on the queued buffers list, which holds + * all buffers queued from userspace + * done_entry: entry on the list that stores all buffers ready + * to be dequeued to userspace + */ enum vb2_buffer_state state; struct list_head queued_entry;