Djam/u-boot
1
0
Fork 0
mirror of https://github.com/u-boot/u-boot.git synced 2025-04-22 20:58:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

expo: Correct some header-file comments

Browse source 
The use of Returns instead of @return still confuses me. Fix some problems
that have crept in.

Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass 2023-06-01 10:22:26 -06:00 • committed by Tom Rini
parent e22596113a
commit d2043b5682
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
boot/scene_internal.h
View file

@ -23,7 +23,7 @@ struct scene *expo_lookup_scene_id(struct expo *exp, uint scene_id);
* *
* @exp: Expo to use * @exp: Expo to use
* @id: ID to use, or 0 to auto-allocate one * @id: ID to use, or 0 to auto-allocate one
* @return: Either @id, or the auto-allocated ID * Returns: Either @id, or the auto-allocated ID
*/ */
uint resolve_id(struct expo *exp, uint id); uint resolve_id(struct expo *exp, uint id);
@ -36,6 +36,7 @@ uint resolve_id(struct expo *exp, uint id);
* @scn: Scene to search * @scn: Scene to search
* @id: ID of object to find * @id: ID of object to find
* @type: Type of the object, or SCENEOBJT_NONE to match any type * @type: Type of the object, or SCENEOBJT_NONE to match any type
* Returns: Object found, or NULL if not found
*/ */
void *scene_obj_find(struct scene *scn, uint id, enum scene_obj_t type); void *scene_obj_find(struct scene *scn, uint id, enum scene_obj_t type);
@ -62,6 +63,7 @@ int scene_obj_add(struct scene *scn, const char *name, uint id,
* *
* @scn: Scene to update * @scn: Scene to update
* @menu: Menu to process * @menu: Menu to process
* Returns: 0 if OK, -ve on error
*/ */
int scene_menu_arrange(struct scene *scn, struct scene_obj_menu *menu); int scene_menu_arrange(struct scene *scn, struct scene_obj_menu *menu);
@ -72,7 +74,7 @@ int scene_menu_arrange(struct scene *scn, struct scene_obj_menu *menu);
* @menu: Menu to use * @menu: Menu to use
* @key: Key code to send (KEY_...) * @key: Key code to send (KEY_...)
* @event: Place to put any event which is generated by the key * @event: Place to put any event which is generated by the key
* @return 0 if OK, -ENOTTY if there is no current menu item, other -ve on other * Returns: 0 if OK, -ENOTTY if there is no current menu item, other -ve on other
* error * error
*/ */
int scene_menu_send_key(struct scene *scn, struct scene_obj_menu *menu, int key, int scene_menu_send_key(struct scene *scn, struct scene_obj_menu *menu, int key,
@ -89,7 +91,7 @@ void scene_menu_destroy(struct scene_obj_menu *menu);
* scene_menu_display() - Display a menu as text * scene_menu_display() - Display a menu as text
* *
* @menu: Menu to display * @menu: Menu to display
* @return 0 if OK, -ENOENT if @id is invalid * Returns: 0 if OK, -ENOENT if @id is invalid
*/ */
int scene_menu_display(struct scene_obj_menu *menu); int scene_menu_display(struct scene_obj_menu *menu);