trivial docuemntation cleanups to address some of the huge number of docuemntation warnings

amiga/font_scan.c

@@ -181,7 +181,7 @@ void ami_font_scan_gui_update(struct ami_font_scan_window *fsw, const char *font
 /**
  * Close GUI showing font scanning progress
  *
- * \param win   pointer to a struct ami_font_scan_window
+ * \param fsw pointer to a struct ami_font_scan_window
  */
 void ami_font_scan_gui_close(struct ami_font_scan_window *fsw)
 {
@@ -240,7 +240,9 @@ ULONG ami_font_scan_font(const char *fontname, lwc_string **glypharray)
 /**
  * Scan all fonts for glyphs.
  *
- * \param  glypharray     an array of 0xffff lwc_string pointers
+ * \param list min list
+ * \param win scan window
+ * \param glypharray an array of 0xffff lwc_string pointers
  * \return number of glyphs found
  */
 ULONG ami_font_scan_fonts(struct MinList *list,

desktop/browser.c

@@ -663,6 +663,9 @@ void browser_window_debug_dump(struct browser_window *bw, FILE *f)
  * \param  url	    URL to start fetching in the new window (copied)
  * \param  clone    The browser window to clone
  * \param  referer  The referring uri (copied), or 0 if none
+ * \param history_add add to history
+ * \param new_tab create a new tab
+ * \return new browser window or NULL on error
  */
 
 struct browser_window *browser_window_create(const char *url,
@@ -757,6 +760,7 @@ void browser_window_initialise_common(struct browser_window *bw,
  * \param  bw	    browser window
  * \param  url	    URL to start fetching (copied)
  * \param  referer  the referring uri (copied), or 0 if none
+ * \param history_add Add to history
  *
  * Any existing fetches in the window are aborted.
  */
@@ -793,6 +797,8 @@ void browser_window_download(struct browser_window *bw, const char *url,
  * \param  bw	    browser window
  * \param  url	    URL to start fetching (copied)
  * \param  referer  the referring uri (copied), or 0 if none
+ * \param history_add add to history
+ * \param parent parent handle
  *
  * Any existing fetches in the window are aborted.
  */
@@ -2281,7 +2287,8 @@ void browser_window_refresh_url_bar(struct browser_window *bw, nsurl *url,
  *
  * \param bw  the browser_window to search all relatives of
  * \param target  the target to locate
- * \param new_window  always return a new window (ie 'Open Link in New Window')
+ * \param mouse The current mouse state
+ * \return The browser window the mouse is in
  */
 
 struct browser_window *browser_window_find_target(struct browser_window *bw,

desktop/browser.h

@@ -315,7 +315,7 @@ struct selection *browser_window_get_selection(struct browser_window *bw);
  * Dump debug info concerning the browser window's contents to file
  *
  * \param  bw    The browser window
- * \param  bw    The file to dump to
+ * \param  f    The file to dump to
  */
 void browser_window_debug_dump(struct browser_window *bw, FILE *f);
 

framebuffer/clipboard.c

@@ -65,10 +65,11 @@ bool gui_empty_clipboard(void)
 /**
  * Add some text to the clipboard, optionally appending a trailing space.
  *
- * \param  text    text to be added
- * \param  length  length of text in bytes
- * \param  space   indicates whether a trailing space should be appended
- * \return true iff successful
+ * \param text text to be added
+ * \param length length of text in bytes
+ * \param space indicates whether a trailing space should be appended
+ * \param fstyle The font style
+ * \return true if successful
  */
 
 bool gui_add_to_clipboard(const char *text, size_t length, bool space,

gtk/sexy_icon_entry.c

@@ -808,9 +808,9 @@ sexy_icon_entry_new(void)
 
 /**
  * sexy_icon_entry_set_icon
- * @entry: A #SexyIconEntry.
- * @position: Icon position.
- * @icon: A #GtkImage to set as the icon.
+ * @param entry A #SexyIconEntry.
+ * @param position Icon position.
+ * @param icon A #GtkImage to set as the icon.
  *
  * Sets the icon shown in the entry
  */
@@ -869,9 +869,9 @@ sexy_icon_entry_set_icon(SexyIconEntry *entry, SexyIconEntryPosition icon_pos,
 
 /**
  * sexy_icon_entry_set_icon_highlight
- * @entry: A #SexyIconEntry;
- * @position: Icon position.
- * @highlight: TRUE if the icon should highlight on mouse-over
+ * @param entry A #SexyIconEntry;
+ * @param position Icon position.
+ * @param highlight TRUE if the icon should highlight on mouse-over
  *
  * Determines whether the icon will highlight on mouse-over.
  */
@@ -896,8 +896,8 @@ sexy_icon_entry_set_icon_highlight(SexyIconEntry *entry,
 
 /**
  * sexy_icon_entry_get_icon
- * @entry: A #SexyIconEntry.
- * @position: Icon position.
+ * @param entry A #SexyIconEntry.
+ * @param position Icon position.
  *
  * Retrieves the image used for the icon
  *
@@ -916,8 +916,8 @@ sexy_icon_entry_get_icon(const SexyIconEntry *entry,
 
 /**
  * sexy_icon_entry_get_icon_highlight
- * @entry: A #SexyIconEntry.
- * @position: Icon position.
+ * @param entry A #SexyIconEntry.
+ * @param position Icon position.
  *
  * Retrieves whether entry will highlight the icon on mouseover.
  *
@@ -947,7 +947,7 @@ clear_button_clicked_cb(SexyIconEntry *icon_entry,
 
 /**
  * sexy_icon_entry_add_clear_button
- * @icon_entry: A #SexyIconEntry.
+ * @param icon_entry A #SexyIconEntry.
  *
  * A convenience function to add a clear button to the end of the entry.
  * This is useful for search boxes.

gtk/toolbar.c

@@ -1033,7 +1033,7 @@ void nsgtk_toolbar_temp_connect(nsgtk_scaffolding *g, nsgtk_toolbar_button i)
 
 /**
  * load toolbar settings from file; file is a set of fields arranged as
- * <itemreference>;<itemlocation>|<itemreference>;<itemlocation>| etc
+ * [itemreference];[itemlocation]|[itemreference];[itemlocation]| etc
  */
 void nsgtk_toolbar_customization_load(nsgtk_scaffolding *g)
 {

utils/hashtable.c

@@ -32,9 +32,9 @@
 
 
 struct hash_entry {
-	char *pairing;			/**< block containing '<key>\0<value>\0' */
-	unsigned int key_length;	/**< length of key */
-	struct hash_entry *next;	/**< next entry */
+	char *pairing;		 /**< block containing 'key\0value\0' */
+	unsigned int key_length; /**< length of key */
+	struct hash_entry *next; /**< next entry */
 };
 
 struct hash_table {

utils/utf8.c

@@ -42,7 +42,7 @@ static utf8_convert_ret utf8_convert(const char *string, size_t len,
  * Encoding of UCS values outside the UTF-16 plane has been removed from
  * RFC3629. This function conforms to RFC2279, however.
  *
- * \param s  The sequence to process
+ * \param s_in  The sequence to process
  * \param l  Length of sequence
  * \return   UCS4 character
  */