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 <sjg@chromium.org>

fixup: comments
This commit is contained in:
Simon Glass 2023-10-01 19:13:23 -06:00 committed by Tom Rini
parent 5fb9e2aab5
commit 909c486d7c
3 changed files with 12 additions and 2 deletions

View file

@ -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)
{

View file

@ -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);

View file

@ -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)