[PATCH v3 1/6] video: Fix video sync kernel-doc format

Michal Simek michal.simek at xilinx.com
Tue Dec 15 15:19:02 CET 2020


Place description below function parameters to make kernel-doc stript
happy. Also rename dev to vid to be aligned with function parameters.

Fixes: 1acafc73bfc7 ("dm: video: Add a video uclass")
Signed-off-by: Michal Simek <michal.simek at xilinx.com>
Reviewed-by: Simon Glass <sjg at chromium.org>
---

(no changes since v2)

Changes in v2:
- New patch is series

./scripts/kernel-doc -v -man include/video.h > /dev/null

---
 include/video.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/video.h b/include/video.h
index 9d09d2409af6..7313b17f7ce8 100644
--- a/include/video.h
+++ b/include/video.h
@@ -151,13 +151,13 @@ int video_clear(struct udevice *dev);
 /**
  * video_sync() - Sync a device's frame buffer with its hardware
  *
+ * @vid:	Device to sync
+ * @force:	True to force a sync even if there was one recently (this is
+ *		very expensive on sandbox)
+ *
  * Some frame buffers are cached or have a secondary frame buffer. This
  * function syncs these up so that the current contents of the U-Boot frame
  * buffer are displayed to the user.
- *
- * @dev:	Device to sync
- * @force:	True to force a sync even if there was one recently (this is
- *		very expensive on sandbox)
  */
 void video_sync(struct udevice *vid, bool force);
 
-- 
2.29.2



More information about the U-Boot mailing list