From 05a64bfde9fe91587a7f8bd3d32f8577b80c7328 Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Sat, 8 Nov 2014 16:49:32 +0000 Subject: fix up more doxygen errors --- atari/gui.c | 4 +-- content/content.c | 72 ++++++++++++--------------------------------- content/content.h | 59 +++++++++++++++++++++++++++++++++++-- content/content_protected.h | 47 +++++++++++++++++++++++++++++ desktop/search.h | 1 - desktop/treeview.c | 6 ++-- desktop/treeview.h | 10 +++---- gtk/scaffolding.c | 7 +++-- gtk/toolbar.c | 11 ++++--- gtk/treeview.c | 5 +++- render/search.c | 2 ++ 11 files changed, 149 insertions(+), 75 deletions(-) diff --git a/atari/gui.c b/atari/gui.c index 759bffb50..6a68b8250 100644 --- a/atari/gui.c +++ b/atari/gui.c @@ -359,8 +359,8 @@ static void gui_window_set_title(struct gui_window *gw, const char *title) /** * Set the status bar of a browser window. * - * \param w gui_window to update - * \param text new status text + * \param w gui_window to update + * \param text new status text */ void gui_window_set_status(struct gui_window *w, const char *text) { diff --git a/content/content.c b/content/content.c index cd493ba44..1316497a9 100644 --- a/content/content.c +++ b/content/content.c @@ -1147,8 +1147,8 @@ int content__get_height(struct content *c) /** * Retrieve available width of content * - * \param c Content to retrieve available width of - * \return Available width of content + * \param h handle to the content. + * \return Available width of content. */ int content_get_available_width(hlcache_handle *h) { @@ -1193,18 +1193,13 @@ const char *content__get_source_data(struct content *c, unsigned long *size) return (const char *) data; } -/** - * Invalidate content reuse data: causes subsequent requests for content URL - * to query server to determine if content can be reused. This is required - * behaviour for forced reloads etc. - * - * \param c Content to invalidate - */ +/* exported interface documented in content/content.h */ void content_invalidate_reuse_data(hlcache_handle *h) { content__invalidate_reuse_data(hlcache_handle_get_content(h)); } +/* exported interface documented in content/content_protected.h */ void content__invalidate_reuse_data(struct content *c) { if (c == NULL || c->llcache == NULL) @@ -1214,17 +1209,13 @@ void content__invalidate_reuse_data(struct content *c) llcache_handle_invalidate_cache_data(c->llcache); } -/** - * Retrieve the refresh URL for a content - * - * \param c Content to retrieve refresh URL from - * \return Pointer to URL, or NULL if none - */ +/* exported interface documented in content/content.h */ nsurl *content_get_refresh_url(hlcache_handle *h) { return content__get_refresh_url(hlcache_handle_get_content(h)); } +/* exported interface documented in content/content_protected.h */ nsurl *content__get_refresh_url(struct content *c) { if (c == NULL) @@ -1234,17 +1225,14 @@ nsurl *content__get_refresh_url(struct content *c) } -/** - * Retrieve the bitmap contained in an image content - * - * \param c Content to retrieve bitmap from - * \return Pointer to bitmap, or NULL if none. - */ +/* exported interface documented in content/content.h */ struct bitmap *content_get_bitmap(hlcache_handle *h) { return content__get_bitmap(hlcache_handle_get_content(h)); } + +/* exported interface documented in content/content_protected.h */ struct bitmap *content__get_bitmap(struct content *c) { struct bitmap *bitmap = NULL; @@ -1261,25 +1249,14 @@ struct bitmap *content__get_bitmap(struct content *c) } -/** - * Determine if a content is opaque from handle - * - * \param h high level cache handle to retrieve opacity from. - * \return false if the content is not opaque or information is not - * known else true. - */ +/* exported interface documented in content/content.h */ bool content_get_opaque(hlcache_handle *h) { return content__get_opaque(hlcache_handle_get_content(h)); } -/** - * Determine if a content is opaque - * - * \param c Content to retrieve opacity from - * \return false if the content is not opaque or information is not - * known else true. - */ + +/* exported interface documented in content/content_protected.h */ bool content__get_opaque(struct content *c) { bool opaque = false; @@ -1300,12 +1277,7 @@ bool content__get_opaque(struct content *c) } -/** - * Retrieve quirkiness of a content - * - * \param h Content to examine - * \return True if content is quirky, false otherwise - */ +/* exported interface documented in content/content.h */ bool content_get_quirks(hlcache_handle *h) { struct content *c = hlcache_handle_get_content(h); @@ -1317,17 +1289,14 @@ bool content_get_quirks(hlcache_handle *h) } -/** - * Retrieve the encoding of a content - * - * \param c Content to retrieve bitmap from - * \return Pointer to bitmap, or NULL if none. - */ +/* exported interface documented in content/content.h */ const char *content_get_encoding(hlcache_handle *h, enum content_encoding_type op) { return content__get_encoding(hlcache_handle_get_content(h), op); } + +/* exported interface documented in content/content_protected.h */ const char *content__get_encoding(struct content *c, enum content_encoding_type op) { const char *encoding = NULL; @@ -1341,18 +1310,15 @@ const char *content__get_encoding(struct content *c, enum content_encoding_type return encoding; } -/** - * Return whether a content is currently locked - * - * \param c Content to test - * \return true iff locked, else false - */ +/* exported interface documented in content/content.h */ bool content_is_locked(hlcache_handle *h) { return content__is_locked(hlcache_handle_get_content(h)); } + +/* exported interface documented in content/content_protected.h */ bool content__is_locked(struct content *c) { return c->locked; diff --git a/content/content.h b/content/content.h index 9c9d64975..5f7d53a70 100644 --- a/content/content.h +++ b/content/content.h @@ -329,13 +329,66 @@ int content_get_height(struct hlcache_handle *c); int content_get_available_width(struct hlcache_handle *c); const char *content_get_source_data(struct hlcache_handle *c, unsigned long *size); -void content_invalidate_reuse_data(struct hlcache_handle *c); -nsurl *content_get_refresh_url(struct hlcache_handle *c); -struct bitmap *content_get_bitmap(struct hlcache_handle *c); + +/** + * Invalidate content reuse data. + * + * causes subsequent requests for content URL to query server to + * determine if content can be reused. This is required behaviour for + * forced reloads etc. + * + * \param h Content handle to invalidate. + */ +void content_invalidate_reuse_data(struct hlcache_handle *h); + +/** + * Retrieve the refresh URL for a content + * + * \param h Content to retrieve refresh URL from + * \return Pointer to URL, or NULL if none + */ +nsurl *content_get_refresh_url(struct hlcache_handle *h); + +/** + * Retrieve the bitmap contained in an image content + * + * \param h handle to the content. + * \return Pointer to bitmap, or NULL if none. + */ +struct bitmap *content_get_bitmap(struct hlcache_handle *h); + +/** + * Determine if a content is opaque from handle + * + * \param h high level cache handle to retrieve opacity from. + * \return false if the content is not opaque or information is not + * known else true. + */ bool content_get_opaque(struct hlcache_handle *h); + +/** + * Retrieve quirkiness of a content + * + * \param h Content to examine + * \return True if content is quirky, false otherwise + */ bool content_get_quirks(struct hlcache_handle *h); + +/** + * Retrieve the encoding of a content + * + * \param h handle to the content. + * \param op encoding operation. + * \return Pointer to content info or NULL if none. + */ const char *content_get_encoding(struct hlcache_handle *h, enum content_encoding_type op); +/** + * Return whether a content is currently locked + * + * \param h handle to the content. + * \return true iff locked, else false + */ bool content_is_locked(struct hlcache_handle *h); #endif diff --git a/content/content_protected.h b/content/content_protected.h index 2647b2e0f..1ae899891 100644 --- a/content/content_protected.h +++ b/content/content_protected.h @@ -194,11 +194,58 @@ int content__get_width(struct content *c); int content__get_height(struct content *c); int content__get_available_width(struct content *c); const char *content__get_source_data(struct content *c, unsigned long *size); + +/** + * Invalidate content reuse data. + * + * causes subsequent requests for content URL to query server to + * determine if content can be reused. This is required behaviour for + * forced reloads etc. + * + * \param c Content to invalidate. + */ void content__invalidate_reuse_data(struct content *c); + +/** + * Retrieve the refresh URL for a content + * + * \param c Content to retrieve refresh URL from + * \return Pointer to URL or NULL if none + */ nsurl *content__get_refresh_url(struct content *c); + +/** + * Retrieve the bitmap contained in an image content + * + * \param c Content to retrieve opacity from + * \return Pointer to bitmap or NULL if none. + */ struct bitmap *content__get_bitmap(struct content *c); + +/** + * Determine if a content is opaque + * + * \param c Content to retrieve opacity from + * \return false if the content is not opaque or information is not + * known else true. + */ bool content__get_opaque(struct content *c); + +/** + * Retrieve the encoding of a content + * + * \param c the content to examine the encoding of. + * \param op encoding operation. + * \return Pointer to content info or NULL if none. + */ const char *content__get_encoding(struct content *c, enum content_encoding_type op); + +/** + * Return whether a content is currently locked + * + * \param c Content to test + * \return true iff locked, else false + */ bool content__is_locked(struct content *c); #endif diff --git a/desktop/search.h b/desktop/search.h index 254acde99..baf382e77 100644 --- a/desktop/search.h +++ b/desktop/search.h @@ -48,7 +48,6 @@ void browser_window_search(struct browser_window *bw, void *context, search_flag * Frees any memory used by the search. * * \param bw The browser window to clean up the search for. - * \param context A context pointer passed to the callbacks. */ void browser_window_search_clear(struct browser_window *bw); diff --git a/desktop/treeview.c b/desktop/treeview.c index fd035571e..d012a0c73 100644 --- a/desktop/treeview.c +++ b/desktop/treeview.c @@ -1354,9 +1354,9 @@ nserror treeview_destroy(treeview *tree) /** * Expand a treeview's nodes * - * \param tree Treeview object to expand nodes in - * \param only_folders Iff true, only folders are expanded. - * \return NSERROR_OK on success, appropriate error otherwise + * \param tree Treeview object to expand nodes in + * \param node The node to expand. + * \return NSERROR_OK on success, appropriate error otherwise. */ static nserror treeview_node_expand_internal(treeview *tree, treeview_node *node) diff --git a/desktop/treeview.h b/desktop/treeview.h index 8f9dd7db9..674c692d5 100644 --- a/desktop/treeview.h +++ b/desktop/treeview.h @@ -226,10 +226,10 @@ nserror treeview_create_node_entry(treeview *tree, /** * Update an folder node in given treeview * - * \param tree Treeview object in which to create entry - * \param folder Folder node to update - * \param fields New field data - * \param data Client data for node event callbacks + * \param tree Treeview object in which to create entry + * \param folder Folder node to update + * \param field New field data + * \param data Client data for node event callbacks * \return NSERROR_OK on success, appropriate error otherwise * * Field name must match name past in treeview_create fields[N-1]. @@ -344,7 +344,7 @@ nserror treeview_contract(treeview *tree, bool all); * * \param tree Treeview object to render * \param x X coordinate to render treeview at - * \param x Y coordinate to render treeview at + * \param y Y coordinate to render treeview at * \param clip Current clip rectangle (wrt tree origin) * \param ctx Current redraw context */ diff --git a/gtk/scaffolding.c b/gtk/scaffolding.c index ff0b2b82c..d18044069 100644 --- a/gtk/scaffolding.c +++ b/gtk/scaffolding.c @@ -2257,10 +2257,11 @@ struct nsgtk_scaffolding *nsgtk_new_scaffolding(struct gui_window *toplevel) return g; } -/** set the title in the window +/** + * set the title in the window * - * @param gw The gui window to set title on - * @param title The title to set (may be NULL) + * \param gw The gui window to set title on + * \param title The title to set (may be NULL) */ void gui_window_set_title(struct gui_window *gw, const char *title) { diff --git a/gtk/toolbar.c b/gtk/toolbar.c index 845344757..5bc5f6c8d 100644 --- a/gtk/toolbar.c +++ b/gtk/toolbar.c @@ -456,11 +456,14 @@ void nsgtk_toolbar_clear_toolbar(GtkWidget *widget, gpointer data) } /** - * add item to toolbar - * \param g the scaffolding whose toolbar an item is added to - * \param i the location in the toolbar + * add item to toolbar. + * * the function should be called, when multiple items are being added, - * in ascending order + * in ascending order. + * + * \param g the scaffolding whose toolbar an item is added to. + * \param i the location in the toolbar. + * \param theme The theme in use. */ void nsgtk_toolbar_add_item_to_toolbar(struct nsgtk_scaffolding *g, int i, struct nsgtk_theme *theme) diff --git a/gtk/treeview.c b/gtk/treeview.c index fa8bd8f3c..71e63184f 100644 --- a/gtk/treeview.c +++ b/gtk/treeview.c @@ -77,7 +77,10 @@ static void nsgtk_tree_redraw_request(int x, int y, int width, int height, void /** * Updates the tree owner following a tree resize * - * \param tree the tree to update the owner of + * \param tree the tree to update the owner of + * \param width The width to resize to. + * \param height The height to resize to. + * \param data The treeview resize. */ static void nsgtk_tree_resized(struct tree *tree, int width, int height, void *data) { diff --git a/render/search.c b/render/search.c index 7c2bd2def..6e5841c7b 100644 --- a/render/search.c +++ b/render/search.c @@ -424,6 +424,8 @@ static bool find_occurrences_text(const char *pattern, int p_len, * * \param string the string to search for * \param string_len length of search string + * \param context The search context to add the entry to. + * \param flags flags to control the search. */ static void search_text(const char *string, int string_len, struct search_context *context, search_flags_t flags) -- cgit v1.2.3