Skip to contentSkip to conversation

media: videobuf2: Fix doc comment

PATCH In review Andrzej Pietrasiewicz 2 participants 2 messages Jan 5, 2024 – Jan 10, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 media: videobuf2: Fix doc comment

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")
---
 include/media/videobuf2-core.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/media/videobuf2-core.h +1 -1
index 4b6a9d2ea372..e41204df19f0 100644
@@ -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;
Signature · 1 line
2.25.1
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 28 lines · Andrzej Pietrasiewicz

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")
---
 include/media/videobuf2-core.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/media/videobuf2-core.h +1 -2
index 4b6a9d2ea372..e41204df19f0 100644
@@ -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;
--
Quoted 2 lines

2.25.1

Thanks for the doc improvement.

Best regards,
Tomasz