From 909c486d7cc52efd0db0a1922778fe5c17e5be24 Mon Sep 17 00:00:00 2001 From: Simon Glass Date: Sun, 1 Oct 2023 19:13:23 -0600 Subject: [PATCH] expo: Fix up comments for get_cur_menuitem_text() et al This internal function could use a comment. Add one. Also tidy up a few other comments. Signed-off-by: Simon Glass fixup: comments --- boot/cedit.c | 10 ++++++++++ boot/scene_internal.h | 2 +- include/expo.h | 2 +- 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/boot/cedit.c b/boot/cedit.c index 73645f70b6..1324a86199 100644 --- a/boot/cedit.c +++ b/boot/cedit.c @@ -229,6 +229,16 @@ static int check_space(int ret, struct abuf *buf) return 0; } +/** + * get_cur_menuitem_text() - Get the text of the currently selected item + * + * Looks up the object for the current item, finds text object for it and looks + * up the string for that text + * + * @menu: Menu to look at + * @strp: Returns a pointer to the next + * Return: 0 if OK, -ENOENT if something was not found + */ static int get_cur_menuitem_text(const struct scene_obj_menu *menu, const char **strp) { diff --git a/boot/scene_internal.h b/boot/scene_internal.h index 695a907dc6..42efcee092 100644 --- a/boot/scene_internal.h +++ b/boot/scene_internal.h @@ -185,7 +185,7 @@ int scene_render_deps(struct scene *scn, uint id); * Renders the menu and all of its attached objects * * @scn: Scene to render - * @menu: Menu render + * @menu: Menu to render * Returns: 0 if OK, -ve on error */ int scene_menu_render_deps(struct scene *scn, struct scene_obj_menu *menu); diff --git a/include/expo.h b/include/expo.h index 9d2e817eb9..5b21110cde 100644 --- a/include/expo.h +++ b/include/expo.h @@ -505,7 +505,7 @@ int scene_txt(struct scene *scn, const char *name, uint id, uint str_id, struct scene_obj_txt **txtp); /** - * scene_txt_str() - add a new string to expr and text object to a scene + * scene_txt_str() - add a new string to expo and text object to a scene * * @scn: Scene to update * @name: Name to use (this is allocated by this call) -- 2.39.5