diff options
Diffstat (limited to 'riscos')
| -rw-r--r-- | riscos/gui/button_bar.h | 11 | ||||
| -rw-r--r-- | riscos/gui/status_bar.c | 8 | ||||
| -rw-r--r-- | riscos/gui/url_bar.h | 12 |
3 files changed, 18 insertions, 13 deletions
diff --git a/riscos/gui/button_bar.h b/riscos/gui/button_bar.h index 9abae3151..b6014f66a 100644 --- a/riscos/gui/button_bar.h +++ b/riscos/gui/button_bar.h @@ -135,14 +135,17 @@ struct button_bar *ro_gui_button_bar_create(struct theme_descriptor *theme, /** - * Link two button bars together: the target being the active bar, and the + * Link two button bars together + * + * Join two button bars the target being the active bar, and the * source being the editing bar used to supply valid buttons. The bars are * checked to ensure that they are not already part of an edit pair, but are * not checked for button-compatibility. * - * \param *target The target button bar. - * \param *source The source button bar. - * \return true if successful; else false. + * \param target The target button bar. + * \param source The source button bar. + * \param refresh The refresh callback + * \return true if successful; else false. */ bool ro_gui_button_bar_link_editor(struct button_bar *target, diff --git a/riscos/gui/status_bar.c b/riscos/gui/status_bar.c index 57a32ae7f..690ddbce9 100644 --- a/riscos/gui/status_bar.c +++ b/riscos/gui/status_bar.c @@ -210,6 +210,7 @@ unsigned int ro_gui_status_bar_get_width(struct status_bar *sb) * Set the visibility status of the status bar * * \param sb the status bar to check the visiblity of + * \param visible if teh status bar should be shown or not. * \return whether the status bar is visible */ void ro_gui_status_bar_set_visible(struct status_bar *sb, bool visible) @@ -263,8 +264,8 @@ void ro_gui_status_bar_set_progress_value(struct status_bar *sb, /** * Set the range of the progress bar * - * \param pb the status bar to set the range of - * \param value the value to use, or 0 to turn off the progress bar + * \param sb the status bar to set the range of + * \param range the range of the progress bar */ void ro_gui_status_bar_set_progress_range(struct status_bar *sb, unsigned int range) @@ -293,7 +294,7 @@ void ro_gui_status_bar_set_progress_range(struct status_bar *sb, /** * Set the icon for the progress bar * - * \param pb the status bar to set the icon for + * \param sb the status bar to set the icon for * \param icon the icon to use, or NULL for no icon */ void ro_gui_status_bar_set_progress_icon(struct status_bar *sb, @@ -308,6 +309,7 @@ void ro_gui_status_bar_set_progress_icon(struct status_bar *sb, /** * Set the text to display in the status bar * + * \param sb the status bar to set the text for * \param text the UTF8 text to display, or NULL for none */ void ro_gui_status_bar_set_text(struct status_bar *sb, const char *text) diff --git a/riscos/gui/url_bar.h b/riscos/gui/url_bar.h index 8e8d291ac..981afb35f 100644 --- a/riscos/gui/url_bar.h +++ b/riscos/gui/url_bar.h @@ -269,9 +269,9 @@ bool ro_gui_url_bar_get_url_extent(struct url_bar *url_bar, os_box *extent); /** * Test a pointer click to see if it was in the URL bar's text field. * - * \param *url_bar The URL Bar to test. - * \param *pointer The pointer event data to test. - * \return true if the click was in the field; else false. + * \param url_bar The URL Bar to test. + * \param pointer The pointer event data to test. + * \return true if the click was in the field; else false. */ bool ro_gui_url_bar_test_for_text_field_click(struct url_bar *url_bar, @@ -281,9 +281,9 @@ bool ro_gui_url_bar_test_for_text_field_click(struct url_bar *url_bar, /** * Test a keypress to see if it was in the URL bar's text field. * - * \param *url_bar The URL Bar to test. - * \param *pointer The pointer event data to test. - * \return true if the click was in the field; else false. + * \param url_bar The URL Bar to test. + * \param key The key pressed + * \return true if the keypress was in the field; else false. */ bool ro_gui_url_bar_test_for_text_field_keypress(struct url_bar *url_bar, |