aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>2015-10-05 12:12:56 (GMT)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>2015-10-05 12:12:56 (GMT)
commitefe98010b80ec4516b2779e1b4e4a8ce16bf89fe (patch)
treeb2b96908fe51ce48e7b299ebd28c37a9e4175e4c
parentf4f24d1fd0803e8b5de5da373276f5046bef7463 (diff)
[media] DocBook: Fix remaining issues with VB2 core documentationHEADmaster
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 <mchehab@osg.samsung.com>
-rw-r--r--include/media/videobuf2-core.h14
1 files changed, 8 insertions, 6 deletions
diff --git a/include/media/videobuf2-core.h b/include/media/videobuf2-core.h
index 128b15a..af9a5d1 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;

Privacy Policy