From 740387be8dc71d34811aa70fdba613dd85ebc651 Mon Sep 17 00:00:00 2001
From: Vincent Sanders <vince@kyllikki.org>
Date: Wed, 12 Nov 2014 16:21:23 +0000
Subject: Doxygen cleanups

---
 render/box_construct.c    |  4 ++--
 render/form_internal.h    |  6 +++---
 render/html.c             |  5 +++--
 render/html_interaction.c | 11 ++++++-----
 render/html_redraw.c      | 27 +++++++++++++++------------
 render/imagemap.c         | 10 +++++-----
 6 files changed, 34 insertions(+), 29 deletions(-)

(limited to 'render')

diff --git a/render/box_construct.c b/render/box_construct.c
index a5e0069b7..97bc11106 100644
--- a/render/box_construct.c
+++ b/render/box_construct.c
@@ -2717,8 +2717,8 @@ no_memory:
 /**
  * Add an option to a form select control (helper function for box_select()).
  *
- * \param  control  select containing the option
- * \param  n	    xml element node for <option>
+ * \param  control  select containing the &lt;option&gt;
+ * \param  n	    xml element node for &lt;option&gt;
  * \return  true on success, false on memory exhaustion
  */
 
diff --git a/render/form_internal.h b/render/form_internal.h
index 7069f876e..07512b508 100644
--- a/render/form_internal.h
+++ b/render/form_internal.h
@@ -118,8 +118,8 @@ bool form_successful_controls(struct form *form,
  *
  * See HTML 4.01 section 17.13.2.
  *
- * \param[in] _form  form to search for successful controls
- * \param[in] _submit_button  control used to submit the form, if any
+ * \param[in] form  form to search for successful controls
+ * \param[in] submit_button  control used to submit the form, if any
  * \param[out] successful_controls  updated to point to linked list of
  *                        fetch_multipart_data, 0 if no controls
  * \return  true on success, false on memory exhaustion
@@ -134,7 +134,7 @@ bool form_successful_controls_dom(struct form *form,
  *
  * \param client_data  data passed to the redraw callback
  * \param control  The select form control for which the menu is being opened
- * \param callback  The redraw callback for the select menu
+ * \param redraw_callback  The callback to redraw the select menu.
  * \param c  The content the select menu is opening for.
  * \return false on memory exhaustion, true otherwise
  */
diff --git a/render/html.c b/render/html.c
index b6bbfa814..4d76d0c8b 100644
--- a/render/html.c
+++ b/render/html.c
@@ -1317,8 +1317,8 @@ void html_redraw_a_box(hlcache_handle *h, struct box *box)
 /**
  * Redraw a box.
  *
- * \param  h	content containing the box, of type CONTENT_HTML
- * \param  box  box to redraw
+ * \param html  content containing the box, of type CONTENT_HTML
+ * \param box  box to redraw.
  */
 
 void html__redraw_a_box(struct html_content *html, struct box *box)
@@ -2126,6 +2126,7 @@ struct box *html_get_box_tree(hlcache_handle *h)
  * Retrieve the charset of an HTML document
  *
  * \param c Content to retrieve charset from
+ * \param op The content encoding operation to perform.
  * \return Pointer to charset, or NULL
  */
 static const char *html_encoding(const struct content *c, enum content_encoding_type op)
diff --git a/render/html_interaction.c b/render/html_interaction.c
index a89cfca7f..4d2234fe3 100644
--- a/render/html_interaction.c
+++ b/render/html_interaction.c
@@ -189,10 +189,11 @@ static void html_box_drag_start(struct box *box, int x, int y)
 /**
  * End overflow scroll scrollbar drags
  *
- * \param  h      html content's high level cache entry
- * \param  mouse  state of mouse buttons and modifier keys
- * \param  x	  coordinate of mouse
- * \param  y	  coordinate of mouse
+ * \param html   html content
+ * \param mouse  state of mouse buttons and modifier keys
+ * \param x	 coordinate of mouse
+ * \param y	 coordinate of mouse
+ * \param dir    Direction of drag
  */
 static size_t html_selection_drag_end(struct html_content *html,
 		browser_mouse_state mouse, int x, int y, int dir)
@@ -1196,7 +1197,7 @@ void html_overflow_scroll_callback(void *client_data,
 /**
  * End overflow scroll scrollbar drags
  *
- * \param  scroll  scrollbar widget
+ * \param  scrollbar  scrollbar widget
  * \param  mouse   state of mouse buttons and modifier keys
  * \param  x	   coordinate of mouse
  * \param  y	   coordinate of mouse
diff --git a/render/html_redraw.c b/render/html_redraw.c
index ed06d472f..3d1f33ce8 100644
--- a/render/html_redraw.c
+++ b/render/html_redraw.c
@@ -131,18 +131,21 @@ static struct box *html_redraw_find_bg_box(struct box *box)
  * Redraw a short text string, complete with highlighting
  * (for selection/search)
  *
- * \param  utf8_text  pointer to UTF-8 text string
- * \param  utf8_len   length of string, in bytes
- * \param  offset     byte offset within textual representation
- * \param  space      width of space that follows string (0 = no space)
- * \param  fstyle     text style to use (pass text size unscaled)
- * \param  x          x ordinate at which to plot text
- * \param  y          y ordinate at which to plot text
- * \param  clip       pointer to current clip rectangle
- * \param  height     height of text string
- * \param  scale      current display scale (1.0 = 100%)
- * \param  excluded   exclude this text string from the selection
- * \param  ctx	      current redraw context
+ * \param utf8_text pointer to UTF-8 text string
+ * \param utf8_len  length of string, in bytes
+ * \param offset    byte offset within textual representation
+ * \param space     width of space that follows string (0 = no space)
+ * \param fstyle    text style to use (pass text size unscaled)
+ * \param x         x ordinate at which to plot text
+ * \param y         y ordinate at which to plot text
+ * \param clip      pointer to current clip rectangle
+ * \param height    height of text string
+ * \param scale     current display scale (1.0 = 100%)
+ * \param excluded  exclude this text string from the selection
+ * \param c         Content being redrawn.
+ * \param sel       Selection context
+ * \param search    Search context
+ * \param ctx	    current redraw context
  * \return true iff successful and redraw should proceed
  */
 
diff --git a/render/imagemap.c b/render/imagemap.c
index 707c6bc31..8f0fcd0a6 100644
--- a/render/imagemap.c
+++ b/render/imagemap.c
@@ -285,9 +285,10 @@ void imagemap_dump(html_content *c)
 /**
  * Adds an imagemap entry to the list
  *
- * \param n     The xmlNode representing the entry to add
+ * \param n  The xmlNode representing the entry to add
  * \param base_url  Base URL for resolving relative URLs
- * \param entry Pointer to list of entries
+ * \param entry  Pointer to list of entries
+ * \param tagtype  The type of tag
  * \return false on memory exhaustion, true otherwise
  */
 static bool
@@ -582,8 +583,7 @@ static bool imagemap_extract_map(dom_node *node, html_content *c,
 /**
  * Extract all imagemaps from a document tree
  *
- * \param c The content
- * \param map_str A dom_string which is "map"
+ * \param c The content to extract imagemaps from.
  * \return false on memory exhaustion, true otherwise
  */
 nserror
@@ -712,7 +712,7 @@ imagemap_point_in_poly(int num, float *xpt, float *ypt, unsigned long x,
 /**
  * Retrieve url associated with imagemap entry
  *
- * \param h        The containing content
+ * \param c        The containing content
  * \param key      The map name to search for
  * \param x        The left edge of the containing box
  * \param y        The top edge of the containing box
-- 
cgit v1.2.3