media: videobuf2: Fix doc comment
authorAndrzej Pietrasiewicz <andrzej.p@collabora.com>
Fri, 5 Jan 2024 12:54:37 +0000 (13:54 +0100)
committerHans Verkuil <hverkuil-cisco@xs4all.nl>
Mon, 5 Feb 2024 11:57:44 +0000 (12:57 +0100)
The documented struct member is called "planes" rather than "vb2_plane".
While at it, make the comments order follow struct members order.

Fixes: 2b1413245550 ("media: vb2-core: Improve kernel-doc markups")
Signed-off-by: Andrzej Pietrasiewicz <andrzej.p@collabora.com>
Acked-by: Tomasz Figa <tfiga@chromium.org>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
include/media/videobuf2-core.h

index 56719a26a46c3d13103d1b8c24b93d0ecf9b4ef8..d9c6b5d4e990855f1a2b868129601e1c4eee3d28 100644 (file)
@@ -271,11 +271,11 @@ struct vb2_buffer {
         *                      skips cache sync/invalidation.
         * skip_cache_sync_on_finish: when set buffer's ->finish() function
         *                      skips cache sync/invalidation.
+        * planes:              per-plane information; 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
-        * vb2_plane:           per-plane information; do not change
         */
        enum vb2_buffer_state   state;
        unsigned int            synced:1;