Skip to content

Commit

Permalink
[media] DocBook: Fix remaining issues with VB2 core documentation
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
mchehab committed Oct 5, 2015
1 parent f4f24d1 commit efe9801
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions include/media/videobuf2-core.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;
Expand Down

0 comments on commit efe9801

Please sign in to comment.