summaryrefslogtreecommitdiff
path: root/desktop
diff options
context:
space:
mode:
authorVincent Sanders <vince@kyllikki.org>2014-11-09 21:49:33 +0000
committerVincent Sanders <vince@kyllikki.org>2014-11-09 21:49:33 +0000
commit7c4c73f1b00bc8ca64fd181662fd9e05b3d4abf5 (patch)
tree34240b73e61a57917b4ac553c7cd1da34b411124 /desktop
parent9f0b252371e8a5070cc8a4ffd5ef3a890a90fe52 (diff)
downloadnetsurf-7c4c73f1b00bc8ca64fd181662fd9e05b3d4abf5.tar.gz
netsurf-7c4c73f1b00bc8ca64fd181662fd9e05b3d4abf5.tar.bz2
Desktop doxygen fixes
Diffstat (limited to 'desktop')
-rw-r--r--desktop/cookie_manager.h12
-rw-r--r--desktop/frames.c8
-rw-r--r--desktop/global_history.c2
-rw-r--r--desktop/global_history.h12
-rw-r--r--desktop/knockout.c10
-rw-r--r--desktop/netsurf.h1
-rw-r--r--desktop/save_complete.c11
-rw-r--r--desktop/searchweb.c2
-rw-r--r--desktop/sslcert_viewer.h8
-rw-r--r--desktop/textarea.c2
-rw-r--r--desktop/textarea.h6
11 files changed, 40 insertions, 34 deletions
diff --git a/desktop/cookie_manager.h b/desktop/cookie_manager.h
index 30a66e598..b7acfe9fc 100644
--- a/desktop/cookie_manager.h
+++ b/desktop/cookie_manager.h
@@ -43,8 +43,8 @@ enum browser_mouse_state;
*
* This must be called before any other cookie_manager_* function.
*
- * \param cw_t Callback table for core_window containing the treeview
- * \param cw The core_window in which the treeview is shown
+ * \param cw_t Callback table for core_window containing the treeview
+ * \param core_window_handle The core_window in which the treeview is shown
* \return NSERROR_OK on success, appropriate error otherwise
*/
nserror cookie_manager_init(struct core_window_callback_table *cw_t,
@@ -79,10 +79,10 @@ void cookie_manager_remove(const struct cookie_data *data);
/**
* Redraw the cookies manager.
*
- * \param x X coordinate to render treeview at
- * \param x Y coordinate to render treeview at
- * \param clip Current clip rectangle (wrt tree origin)
- * \param ctx Current redraw context
+ * \param x X 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
*/
void cookie_manager_redraw(int x, int y, struct rect *clip,
const struct redraw_context *ctx);
diff --git a/desktop/frames.c b/desktop/frames.c
index ff9b88286..3e5556f5c 100644
--- a/desktop/frames.c
+++ b/desktop/frames.c
@@ -284,8 +284,8 @@ void browser_window_recalculate_iframes(struct browser_window *bw)
/**
* Create and open a frameset for a browser window.
*
- * \param bw The browser window to create the frameset for
- * \param iframe The frameset to create
+ * \param bw The browser window to create the frameset for
+ * \param frameset The frameset to create
*/
void browser_window_create_frameset(struct browser_window *bw,
@@ -638,7 +638,9 @@ void browser_window_recalculate_frameset(struct browser_window *bw)
/**
* Resize a browser window that is a frame.
*
- * \param bw The browser window to resize
+ * \param bw The browser window to resize
+ * \param x The new width to set.
+ * \param y The new height to set.
*/
void browser_window_resize_frame(struct browser_window *bw, int x, int y)
diff --git a/desktop/global_history.c b/desktop/global_history.c
index aaf4239ad..75c9aead1 100644
--- a/desktop/global_history.c
+++ b/desktop/global_history.c
@@ -245,7 +245,7 @@ static inline nserror global_history_get_parent_treeview_node(
* Set a global history entry's data from the url_data.
*
* \param e Global history entry to set up
- * \param url_data Data associated with entry's URL
+ * \param data Data associated with entry's URL
* \return NSERROR_OK on success, appropriate error otherwise
*/
static nserror global_history_create_treeview_field_data(
diff --git a/desktop/global_history.h b/desktop/global_history.h
index a2281ad60..bfbd13258 100644
--- a/desktop/global_history.h
+++ b/desktop/global_history.h
@@ -39,8 +39,8 @@ enum browser_mouse_state;
*
* This must be called before any other global_history_* function.
*
- * \param cw_t Callback table for core_window containing the treeview
- * \param cw The core_window in which the treeview is shown
+ * \param cw_t Callback table for core_window containing the treeview.
+ * \param core_window_handle The core_window in which the treeview is shown.
* \return NSERROR_OK on success, appropriate error otherwise
*/
nserror global_history_init(struct core_window_callback_table *cw_t,
@@ -79,10 +79,10 @@ nserror global_history_export(const char *path, const char *title);
/**
* Redraw the global history.
*
- * \param x X coordinate to render treeview at
- * \param x Y coordinate to render treeview at
- * \param clip Current clip rectangle (wrt tree origin)
- * \param ctx Current redraw context
+ * \param x X 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
*/
void global_history_redraw(int x, int y, struct rect *clip,
const struct redraw_context *ctx);
diff --git a/desktop/knockout.c b/desktop/knockout.c
index fa827cb39..0321423fd 100644
--- a/desktop/knockout.c
+++ b/desktop/knockout.c
@@ -404,11 +404,11 @@ bool knockout_plot_flush(void)
/**
* Knockout a section of previous rendering
*
- * \param x0 the left edge of the removal box
- * \param y0 the bottom edge of the removal box
- * \param x1 the right edge of the removal box
- * \param y1 the top edge of the removal box
- * \param box the parent box set to consider, or NULL for top level
+ * \param x0 The left edge of the removal box
+ * \param y0 The bottom edge of the removal box
+ * \param x1 The right edge of the removal box
+ * \param y1 The top edge of the removal box
+ * \param owner The parent box set to consider, or NULL for top level
*/
void knockout_calculate(int x0, int y0, int x1, int y1, struct knockout_box *owner)
{
diff --git a/desktop/netsurf.h b/desktop/netsurf.h
index 3ce8f3bab..4f3721945 100644
--- a/desktop/netsurf.h
+++ b/desktop/netsurf.h
@@ -41,6 +41,7 @@ nserror netsurf_register(struct netsurf_table *table);
* Initialise netsurf core.
*
* @param messages path to translation mesage file.
+ * @param store_path path to persistant storage.
* @return NSERROR_OK on success or error code on faliure.
*/
nserror netsurf_init(const char *messages, const char *store_path);
diff --git a/desktop/save_complete.c b/desktop/save_complete.c
index fd58f5f8b..e5359e4f8 100644
--- a/desktop/save_complete.c
+++ b/desktop/save_complete.c
@@ -176,11 +176,12 @@ static bool save_complete_save_buffer(save_complete_ctx *ctx,
/**
* Rewrite stylesheet \@import rules for save complete.
*
- * \param source stylesheet source
- * \param size size of source
- * \param base url of stylesheet
- * \param osize updated with the size of the result
- * \return converted source, or NULL on out of memory
+ * \param ctx Save complete context.
+ * \param source stylesheet source.
+ * \param size size of source.
+ * \param base url of stylesheet.
+ * \param osize updated with the size of the result.
+ * \return converted source, or NULL on out of memory.
*/
static char *save_complete_rewrite_stylesheet_urls(save_complete_ctx *ctx,
diff --git a/desktop/searchweb.c b/desktop/searchweb.c
index abd11a7d6..64d9d40b4 100644
--- a/desktop/searchweb.c
+++ b/desktop/searchweb.c
@@ -217,7 +217,7 @@ parse_providers(char *providersd,
/**
* create a url for a search provider and a term
*
- * \param The provider to use.
+ * \param provider The provider to use.
* \param term The term being searched for.
* \param url_out The resulting url.
* \return NSERROR_OK on sucess or appropriate error code.
diff --git a/desktop/sslcert_viewer.h b/desktop/sslcert_viewer.h
index d6b0c1b8b..238cac37d 100644
--- a/desktop/sslcert_viewer.h
+++ b/desktop/sslcert_viewer.h
@@ -55,9 +55,9 @@ nserror sslcert_viewer_create_session_data(
*
* This iterates through the certificates, building a treeview.
*
- * \param cw_t Callback table for cert viewer's core_window
- * \param cw The core_window in which the cert viewer is shown
- * \param ssl_d SSL certificate session data
+ * \param cw_t Callback table for cert viewer's core_window
+ * \param core_window_handle The core_window in which the cert viewer is shown
+ * \param ssl_d SSL certificate session data
* \return NSERROR_OK on success, appropriate error otherwise
*/
nserror sslcert_viewer_init(struct core_window_callback_table *cw_t,
@@ -95,7 +95,7 @@ nserror sslcert_viewer_accept(struct sslcert_session_data *ssl_d);
*
* \param ssl_d SSL certificate session data
* \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/desktop/textarea.c b/desktop/textarea.c
index 8d4fd137d..ece529e48 100644
--- a/desktop/textarea.c
+++ b/desktop/textarea.c
@@ -497,7 +497,7 @@ static bool textarea_set_caret_internal(struct textarea *ta, int caret_b)
* \param ta Text area
* \param b_start First character (inclusive) byte offset
* \param b_end Last character (exclusive) byte offset
- * \parm force_redraw Redraw whether selection changed or not
+ * \param force_redraw Redraw whether selection changed or not
* \return true on success false otherwise
*/
static bool textarea_select(struct textarea *ta, int b_start, int b_end,
diff --git a/desktop/textarea.h b/desktop/textarea.h
index 5f9e58175..66d5cbc5e 100644
--- a/desktop/textarea.h
+++ b/desktop/textarea.h
@@ -111,10 +111,11 @@ typedef struct textarea_setup {
typedef void(*textarea_client_callback)(void *data, struct textarea_msg *msg);
/**
- * Create a text area
+ * Create a text area.
*
+ * \param flags flags controlling the text area creation
* \param setup textarea settings and style
- * \param redraw_callback will be called when textarea wants to redraw
+ * \param callback will be called when textarea wants to redraw
* \param data user specified data which will be passed to callbacks
* \return Opaque handle for textarea or 0 on error
*/
@@ -143,6 +144,7 @@ bool textarea_set_text(struct textarea *ta, const char *text);
*
* \param ta Text area
* \param text UTF-8 text to set text area's contents to
+ * \param text_length length of text.
* \return true on success, false on memory exhaustion or if ta lacks caret
*/
bool textarea_drop_text(struct textarea *ta, const char *text,