From e8277f2954229822fae75cb9b062b90a95c37a71 Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Wed, 12 Nov 2014 22:36:11 +0000 Subject: doxgen warning fixes in riscos frontend. --- riscos/gui/button_bar.h | 3 ++- riscos/gui/status_bar.c | 2 +- riscos/iconbar.c | 11 ++++++----- riscos/image.c | 4 ++-- riscos/menus.c | 8 +++----- riscos/message.c | 3 ++- riscos/save.c | 6 +++--- riscos/url_suggest.c | 6 +++--- riscos/wimp.c | 16 +++++++++------- 9 files changed, 31 insertions(+), 28 deletions(-) (limited to 'riscos') diff --git a/riscos/gui/button_bar.h b/riscos/gui/button_bar.h index b6014f66a..a1f7e8b9f 100644 --- a/riscos/gui/button_bar.h +++ b/riscos/gui/button_bar.h @@ -144,7 +144,8 @@ struct button_bar *ro_gui_button_bar_create(struct theme_descriptor *theme, * * \param target The target button bar. * \param source The source button bar. - * \param refresh The refresh callback + * \param refresh The refresh callback. + * \param client_data context passed to the refresh callback * \return true if successful; else false. */ diff --git a/riscos/gui/status_bar.c b/riscos/gui/status_bar.c index 690ddbce9..c269b918b 100644 --- a/riscos/gui/status_bar.c +++ b/riscos/gui/status_bar.c @@ -247,7 +247,7 @@ bool ro_gui_status_bar_get_visible(struct status_bar *sb) /** * Set the value of the progress bar * - * \param pb the status bar to set the progress of + * \param sb the status bar to set the progress of * \param value the value to use */ void ro_gui_status_bar_set_progress_value(struct status_bar *sb, diff --git a/riscos/iconbar.c b/riscos/iconbar.c index 9ca58c595..c234bc25d 100644 --- a/riscos/iconbar.c +++ b/riscos/iconbar.c @@ -187,11 +187,12 @@ void ro_gui_iconbar_menu_warning(wimp_w w, wimp_i i, wimp_menu *menu, /** * Handle selections from the iconbar menu * - * \param w The window owning the menu. - * \param i The icon owning the menu. - * \param *selection The wimp menu selection data. - * \param action The selected menu action. - * \return true if action accepted; else false. + * \param w The window owning the menu. + * \param i The icon owning the menu. + * \param menu The wimp menu + * \param selection The wimp menu selection data. + * \param action The selected menu action. + * \return true if action accepted; else false. */ bool ro_gui_iconbar_menu_select(wimp_w w, wimp_i i, wimp_menu *menu, diff --git a/riscos/image.c b/riscos/image.c index 07baecd60..18ad4859e 100644 --- a/riscos/image.c +++ b/riscos/image.c @@ -100,7 +100,7 @@ bool image_redraw(osspriteop_area *area, int x, int y, int req_width, /** * Plot an image at the given coordinates using tinct * - * \param area The sprite area containing the sprite + * \param header The sprite header * \param x Left edge of sprite * \param y Top edge of sprite * \param req_width The requested width of the sprite @@ -154,7 +154,7 @@ bool image_redraw_tinct(osspriteop_id header, int x, int y, /** * Plot an image at the given coordinates using os_spriteop * - * \param area The sprite area containing the sprite + * \param header The sprite header * \param x Left edge of sprite * \param y Top edge of sprite * \param req_width The requested width of the sprite diff --git a/riscos/menus.c b/riscos/menus.c index 3aa26791c..a7926ff70 100644 --- a/riscos/menus.c +++ b/riscos/menus.c @@ -510,10 +510,8 @@ void ro_gui_menu_refresh(wimp_menu *menu) /** * Creates a wimp_menu and adds it to the list to handle actions for. * - * \param *menu The data to create the menu with - * \param *callbacks A callback table for the menu (NULL if to be - * handled in the 'old-fashined way' by menus.c). - * \return The menu created, or NULL on failure + * \param menu The data to create the menu with + * \return The menu created, or NULL on failure */ wimp_menu *ro_gui_menu_define_menu(const struct ns_menu *menu) { @@ -807,7 +805,7 @@ menu_action ro_gui_menu_find_action(wimp_menu *menu, wimp_menu_entry *menu_entry * * \param menu the menu containing the action * \param action the action to tick/untick - * \param ticked whether to set the item as ticked + * \param shaded whether to set the item as shaded */ void ro_gui_menu_set_entry_shaded(wimp_menu *menu, menu_action action, bool shaded) diff --git a/riscos/message.c b/riscos/message.c index bfb33a8c9..d129d5d31 100644 --- a/riscos/message.c +++ b/riscos/message.c @@ -182,7 +182,8 @@ struct active_message *ro_message_add(unsigned int message_code, /** * Attempts to route a message. * - * \param message the message to attempt to route + * \param event wimp event + * \param message the message to attempt to route * \return true if message was routed, false otherwise */ bool ro_message_handle_message(wimp_event_no event, wimp_message *message) diff --git a/riscos/save.c b/riscos/save.c index de0046ff0..b5d96c460 100644 --- a/riscos/save.c +++ b/riscos/save.c @@ -799,9 +799,9 @@ void ro_gui_save_datasave_ack(wimp_message *message) /** * Does the actual saving * - * \param c content to save (or NULL for other) - * \param path path to save as - * \param force_overwrite true iff required to overwrite without prompting + * \param h handle to content to save (or NULL for other) + * \param path path to save as + * \param force_overwrite true iff required to overwrite without prompting * \return true on success, * false on (i) error and error reported * or (ii) deferred awaiting user confirmation diff --git a/riscos/url_suggest.c b/riscos/url_suggest.c index 78cde5cfb..3f6b6b54d 100644 --- a/riscos/url_suggest.c +++ b/riscos/url_suggest.c @@ -53,7 +53,7 @@ wimp_menu *ro_gui_url_suggest_menu = (wimp_menu *) &url_suggest_menu_block; * Initialise the URL suggestion menu. This MUST be called before anything * tries to use the URL menu. * - * /return true if initialisation was OK; else false. + * \return true if initialisation was OK; else false. */ bool ro_gui_url_suggest_init(void) @@ -72,10 +72,10 @@ bool ro_gui_url_suggest_init(void) /** * Check if there is a URL suggestion menu available for use. * - * \TODO -- Ideally this should be able to decide if there's a menu + * \todo Ideally this should be able to decide if there's a menu * available without actually having to build it all. * - * /return true if the menu has entries; else false. + * \return true if the menu has entries; else false. */ bool ro_gui_url_suggest_get_menu_available(void) diff --git a/riscos/wimp.c b/riscos/wimp.c index 156dbe692..fe730a706 100644 --- a/riscos/wimp.c +++ b/riscos/wimp.c @@ -380,9 +380,10 @@ void ro_gui_set_icon_integer(wimp_w w, wimp_i i, int value) /** * Set the contents of an icon to a number. * - * \param w window handle - * \param i icon handle - * \param value value + * \param w window handle + * \param i icon handle + * \param value value to use in icon. + * \param decimal_places The number of decimal places to use. */ void ro_gui_set_icon_decimal(wimp_w w, wimp_i i, int value, int decimal_places) { @@ -414,9 +415,10 @@ void ro_gui_set_icon_decimal(wimp_w w, wimp_i i, int value, int decimal_places) /** * Get the contents of an icon as a number. * - * \param w window handle - * \param i icon handle - * \param value value + * \param w window handle + * \param i icon handle + * \param decimal_places number of places to show. + * \return value used. */ int ro_gui_get_icon_decimal(wimp_w w, wimp_i i, int decimal_places) { @@ -727,7 +729,7 @@ void ro_gui_set_window_title(wimp_w w, const char *text) /** * Places the caret in the first available icon * - * \w the window to place the caret in + * \param w the window to place the caret in * \return true if the caret was placed, false otherwise */ bool ro_gui_set_caret_first(wimp_w w) -- cgit v1.2.3