aboutsummaryrefslogtreecommitdiffstats
path: root/include/media
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>2015-10-05 08:12:56 -0400
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>2015-10-05 08:12:56 -0400
commitefe98010b80ec4516b2779e1b4e4a8ce16bf89fe (patch)
treeb2b96908fe51ce48e7b299ebd28c37a9e4175e4c /include/media
parentf4f24d1fd0803e8b5de5da373276f5046bef7463 (diff)
[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 <mchehab@osg.samsung.com>
Diffstat (limited to 'include/media')
-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 128b15ad5497..af9a5d177fca 100644
--- a/include/media/videobuf2-core.h
+++ b/include/media/videobuf2-core.h
@@ -202,11 +202,6 @@ struct vb2_queue;
202 * @num_planes: number of planes in the buffer 202 * @num_planes: number of planes in the buffer
203 * on an internal driver queue 203 * on an internal driver queue
204 * @planes: private per-plane information; do not change 204 * @planes: private per-plane information; do not change
205 * @state: current buffer state; do not change
206 * @queued_entry: entry on the queued buffers list, which holds all
207 * buffers queued from userspace
208 * @done_entry: entry on the list that stores all buffers ready to
209 * be dequeued to userspace
210 */ 205 */
211struct vb2_buffer { 206struct vb2_buffer {
212 struct vb2_queue *vb2_queue; 207 struct vb2_queue *vb2_queue;
@@ -216,7 +211,14 @@ struct vb2_buffer {
216 unsigned int num_planes; 211 unsigned int num_planes;
217 struct vb2_plane planes[VIDEO_MAX_PLANES]; 212 struct vb2_plane planes[VIDEO_MAX_PLANES];
218 213
219 /* Private: internal use only */ 214 /* private: internal use only
215 *
216 * state: current buffer state; do not change
217 * queued_entry: entry on the queued buffers list, which holds
218 * all buffers queued from userspace
219 * done_entry: entry on the list that stores all buffers ready
220 * to be dequeued to userspace
221 */
220 enum vb2_buffer_state state; 222 enum vb2_buffer_state state;
221 223
222 struct list_head queued_entry; 224 struct list_head queued_entry;