[media] DocBook: Fix remaining issues with VB2 core documentation
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>
Mon, 5 Oct 2015 12:12:56 +0000 (09:12 -0300)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>
Mon, 5 Oct 2015 12:12:56 +0000 (09:12 -0300)
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>
include/media/videobuf2-core.h

index 128b15ad549788305154aa1771f4b0b013692462..af9a5d177fca7fb5b617c7309a839e1f873297fb 100644 (file)
@@ -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;