diff options
author | Vincent Sanders <vince@kyllikki.org> | 2014-11-12 19:31:39 +0000 |
---|---|---|
committer | Vincent Sanders <vince@kyllikki.org> | 2014-11-12 19:31:39 +0000 |
commit | 1a7d00076d0db4ea5b4d8bbd785e13890ef09d60 (patch) | |
tree | 01b01237b5787fe64cb5444e04250fe1939905d4 | |
parent | 740387be8dc71d34811aa70fdba613dd85ebc651 (diff) | |
download | netsurf-1a7d00076d0db4ea5b4d8bbd785e13890ef09d60.tar.gz netsurf-1a7d00076d0db4ea5b4d8bbd785e13890ef09d60.tar.bz2 |
cleanup Doxygen warnings
-rw-r--r-- | gtk/sexy_icon_entry.c | 17 | ||||
-rw-r--r-- | render/html.c | 42 | ||||
-rw-r--r-- | render/html_internal.h | 2 | ||||
-rw-r--r-- | render/html_redraw.c | 4 | ||||
-rw-r--r-- | render/textplain.c | 33 | ||||
-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 |
8 files changed, 68 insertions, 61 deletions
diff --git a/gtk/sexy_icon_entry.c b/gtk/sexy_icon_entry.c index 172b92117..b2899b1ba 100644 --- a/gtk/sexy_icon_entry.c +++ b/gtk/sexy_icon_entry.c @@ -22,6 +22,7 @@ * or write to the Free Software Foundation, Inc., * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ + #include <string.h> #include <gtk/gtk.h> @@ -120,7 +121,7 @@ sexy_icon_entry_class_init(SexyIconEntryClass *klass) widget_class->button_press_event = sexy_icon_entry_button_press; widget_class->button_release_event = sexy_icon_entry_button_release; - /** + /* * SexyIconEntry::icon-pressed: * @entry: The entry on which the signal is emitted. * @icon_pos: The position of the clicked icon. @@ -142,7 +143,7 @@ sexy_icon_entry_class_init(SexyIconEntryClass *klass) G_TYPE_INT, G_TYPE_INT); - /** + /* * SexyIconEntry::icon-released: * @entry: The entry on which the signal is emitted. * @icon_pos: The position of the clicked icon. @@ -793,7 +794,7 @@ sexy_icon_entry_button_release(GtkWidget *widget, GdkEventButton *event) return FALSE; } -/** +/* * sexy_icon_entry_new * * Creates a new SexyIconEntry widget. @@ -806,7 +807,7 @@ sexy_icon_entry_new(void) return GTK_WIDGET(g_object_new(SEXY_TYPE_ICON_ENTRY, NULL)); } -/** +/* * sexy_icon_entry_set_icon * @param entry A #SexyIconEntry. * @param position Icon position. @@ -867,7 +868,7 @@ sexy_icon_entry_set_icon(SexyIconEntry *entry, SexyIconEntryPosition icon_pos, update_icon(NULL, NULL, entry); } -/** +/* * sexy_icon_entry_set_icon_highlight * @param entry A #SexyIconEntry; * @param position Icon position. @@ -894,7 +895,7 @@ sexy_icon_entry_set_icon_highlight(SexyIconEntry *entry, icon_info->highlight = highlight; } -/** +/* * sexy_icon_entry_get_icon * @param entry A #SexyIconEntry. * @param position Icon position. @@ -914,7 +915,7 @@ sexy_icon_entry_get_icon(const SexyIconEntry *entry, return entry->priv->icons[icon_pos].icon; } -/** +/* * sexy_icon_entry_get_icon_highlight * @param entry A #SexyIconEntry. * @param position Icon position. @@ -945,7 +946,7 @@ clear_button_clicked_cb(SexyIconEntry *icon_entry, gtk_entry_set_text(GTK_ENTRY(icon_entry), ""); } -/** +/* * sexy_icon_entry_add_clear_button * @param icon_entry A #SexyIconEntry. * diff --git a/render/html.c b/render/html.c index 4d76d0c8b..f3667d470 100644 --- a/render/html.c +++ b/render/html.c @@ -540,12 +540,8 @@ static bool html_process_img(html_content *c, dom_node *node) return success; } -/** - * Complete conversion of an HTML document - * - * \param c Content to convert - */ -void html_finish_conversion(html_content *c) +/* exported function documented in render/html_internal.h */ +void html_finish_conversion(html_content *htmlc) { union content_msg_data msg_data; dom_exception exc; /* returned by libdom functions */ @@ -553,17 +549,17 @@ void html_finish_conversion(html_content *c) nserror error; /* Bail out if we've been aborted */ - if (c->aborted) { - content_broadcast_errorcode(&c->base, NSERROR_STOPPED); - content_set_error(&c->base); + if (htmlc->aborted) { + content_broadcast_errorcode(&htmlc->base, NSERROR_STOPPED); + content_set_error(&htmlc->base); return; } /* create new css selection context */ - error = html_css_new_selection_context(c, &c->select_ctx); + error = html_css_new_selection_context(htmlc, &htmlc->select_ctx); if (error != NSERROR_OK) { - content_broadcast_errorcode(&c->base, error); - content_set_error(&c->base); + content_broadcast_errorcode(&htmlc->base, error); + content_set_error(&htmlc->base); return; } @@ -572,29 +568,29 @@ void html_finish_conversion(html_content *c) * object, but with its target set to the Document object (and * the currentTarget set to the Window object) */ - js_fire_event(c->jscontext, "load", c->document, NULL); + js_fire_event(htmlc->jscontext, "load", htmlc->document, NULL); /* convert dom tree to box tree */ - LOG(("DOM to box (%p)", c)); - content_set_status(&c->base, messages_get("Processing")); + LOG(("DOM to box (%p)", htmlc)); + content_set_status(&htmlc->base, messages_get("Processing")); msg_data.explicit_status_text = NULL; - content_broadcast(&c->base, CONTENT_MSG_STATUS, msg_data); + content_broadcast(&htmlc->base, CONTENT_MSG_STATUS, msg_data); - exc = dom_document_get_document_element(c->document, (void *) &html); + exc = dom_document_get_document_element(htmlc->document, (void *) &html); if ((exc != DOM_NO_ERR) || (html == NULL)) { LOG(("error retrieving html element from dom")); - content_broadcast_errorcode(&c->base, NSERROR_DOM); - content_set_error(&c->base); + content_broadcast_errorcode(&htmlc->base, NSERROR_DOM); + content_set_error(&htmlc->base); return; } - error = dom_to_box(html, c, html_box_convert_done); + error = dom_to_box(html, htmlc, html_box_convert_done); if (error != NSERROR_OK) { LOG(("box conversion failed")); dom_node_unref(html); - html_object_free_objects(c); - content_broadcast_errorcode(&c->base, error); - content_set_error(&c->base); + html_object_free_objects(htmlc); + content_broadcast_errorcode(&htmlc->base, error); + content_set_error(&htmlc->base); return; } diff --git a/render/html_internal.h b/render/html_internal.h index 1a878031b..fd5cf8443 100644 --- a/render/html_internal.h +++ b/render/html_internal.h @@ -227,7 +227,7 @@ struct browser_window *html_get_browser_window(struct content *c); /** * Complete conversion of an HTML document * - * \param htmlc Content to convert + * \param htmlc Content to convert */ void html_finish_conversion(html_content *htmlc); diff --git a/render/html_redraw.c b/render/html_redraw.c index 3d1f33ce8..091ece0f5 100644 --- a/render/html_redraw.c +++ b/render/html_redraw.c @@ -329,6 +329,7 @@ static plot_style_t plot_style_fillbdr_dlight = { * \param style border line style * \param thickness border thickness * \param rectangular whether border is rectangular + * \param clip cliping area for redrawing border. * \param ctx current redraw context * \return true if successful, false otherwise */ @@ -690,6 +691,7 @@ static bool html_redraw_border_plot(const int side, const int *p, colour c, * \param y_parent coordinate of top padding edge of parent of box * \param p_width width of padding box * \param p_height height of padding box + * \param clip cliping area for redrawing border. * \param scale scale for redraw * \param ctx current redraw context * \return true if successful, false otherwise @@ -923,6 +925,7 @@ static bool html_redraw_borders(struct box *box, int x_parent, int y_parent, * * \param box BOX_INLINE which created the border * \param b coordinates of border edge rectangle + * \param clip cliping area for redrawing border. * \param scale scale for redraw * \param first true if this is the first rectangle associated with the inline * \param last true if this is the last rectangle associated with the inline @@ -1796,6 +1799,7 @@ static bool html_redraw_text_decoration(struct box *box, * Redraw the text content of a box, possibly partially highlighted * because the text has been selected, or matches a search operation. * + * \param html The html content to redraw text within. * \param box box with text content * \param x x co-ord of box * \param y y co-ord of box diff --git a/render/textplain.c b/render/textplain.c index 9d87fbf1e..9a63da1dd 100644 --- a/render/textplain.c +++ b/render/textplain.c @@ -688,7 +688,7 @@ void textplain_mouse_track(struct content *c, struct browser_window *bw, * * \param c content of type textplain * \param bw browser window - * \param click type of mouse click + * \param mouse mouse state on action * \param x coordinate of mouse * \param y coordinate of mouse */ @@ -772,11 +772,10 @@ bool textplain_keypress(struct content *c, uint32_t key) /** * Handle search. * - * \param c content of type text - * \param gui_callbacks vtable for updating front end - * \param gui_data front end private data - * \param flags search flags - * \param string search string + * \param c content of type text + * \param gui_data front end private data + * \param flags search flags + * \param string search string */ void textplain_search(struct content *c, void *gui_data, search_flags_t flags, const char *string) @@ -1029,7 +1028,7 @@ char *textplain_get_selection(struct content *c) /** * Retrieve number of lines in content * - * \param h Content to retrieve line count from + * \param c Content to retrieve line count from * \return Number of lines */ unsigned long textplain_line_count(struct content *c) @@ -1044,7 +1043,7 @@ unsigned long textplain_line_count(struct content *c) /** * Retrieve the size (in bytes) of text data * - * \param h Content to retrieve size of + * \param c Content to retrieve size of * \return Size, in bytes, of data */ size_t textplain_size(struct content *c) @@ -1057,12 +1056,14 @@ size_t textplain_size(struct content *c) } /** - * Return byte offset within UTF8 textplain content, given the co-ordinates - * of a point within a textplain content. 'dir' specifies the direction in - * which to search (-1 = above-left, +1 = below-right) if the co-ordinates are not - * contained within a line. + + * Return byte offset within UTF8 textplain content. + * + * given the co-ordinates of a point within a textplain content. 'dir' + * specifies the direction in which to search (-1 = above-left, +1 = + * below-right) if the co-ordinates are not contained within a line. * - * \param h content of type CONTENT_TEXTPLAIN + * \param c content of type CONTENT_TEXTPLAIN * \param x x ordinate of point * \param y y ordinate of point * \param dir direction of search if not within line @@ -1216,7 +1217,7 @@ int textplain_coord_from_offset(const char *text, size_t offset, size_t length) * Given a range of byte offsets within a UTF8 textplain content, * return a box that fully encloses the text * - * \param h content of type CONTENT_TEXTPLAIN + * \param c content of type CONTENT_TEXTPLAIN * \param start byte offset of start of text range * \param end byte offset of end * \param r rectangle to be completed @@ -1273,7 +1274,7 @@ void textplain_coords_from_range(struct content *c, unsigned start, /** * Return a pointer to the requested line of text. * - * \param h content of type CONTENT_TEXTPLAIN + * \param c content of type CONTENT_TEXTPLAIN * \param lineno line number * \param poffset receives byte offset of line start within text * \param plen receives length of returned line @@ -1303,7 +1304,7 @@ char *textplain_get_line(struct content *c, unsigned lineno, * text to fit the window width. Thus only hard newlines are preserved * in the saved/copied text of a selection. * - * \param h content of type CONTENT_TEXTPLAIN + * \param c content of type CONTENT_TEXTPLAIN * \param start starting byte offset within UTF-8 text * \param end ending byte offset * \param plen receives validated length 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, |