From d1f2d29e102a3c429c892c70a7125cad3add5fe0 Mon Sep 17 00:00:00 2001
From: Vincent Sanders <vince@kyllikki.org>
Date: Mon, 10 Nov 2014 17:00:15 +0000
Subject: Doxygen cleanups and documentation additions

---
 gtk/font_pango.c  |  6 +++---
 gtk/menu.c        |  3 ++-
 gtk/scaffolding.c | 10 ++++++----
 3 files changed, 11 insertions(+), 8 deletions(-)

(limited to 'gtk')

diff --git a/gtk/font_pango.c b/gtk/font_pango.c
index c49b32b25..ee506380f 100644
--- a/gtk/font_pango.c
+++ b/gtk/font_pango.c
@@ -224,7 +224,7 @@ bool nsfont_split(const plot_font_style_t *fstyle,
  * \param  y	   y coordinate
  * \param  string  UTF-8 string to measure
  * \param  length  length of string
- * \param  style   plot style for this text
+ * \param  fstyle  plot style for this text
  * \return  true on success, false on error and error reported
  */
 
@@ -259,8 +259,8 @@ bool nsfont_paint(int x, int y, const char *string, size_t length,
 /**
  * Convert a plot style to a PangoFontDescription.
  *
- * \param  style	plot style for this text
- * \return  a new Pango font description
+ * \param fstyle plot style for this text
+ * \return A new Pango font description
  */
 
 PangoFontDescription *nsfont_style_to_description(
diff --git a/gtk/menu.c b/gtk/menu.c
index 065ee6bdf..8b684d6c6 100644
--- a/gtk/menu.c
+++ b/gtk/menu.c
@@ -275,8 +275,9 @@ static struct nsgtk_developer_submenu *nsgtk_menu_developer_submenu(
 
 /**
  * creates the file menu
+ *
  * \param group The gtk 'global' accelerator reference
- * \param parent The parent menu to attach to or NULL
+ * \return The new file menu or NULL on error
  */
 static struct nsgtk_file_menu *nsgtk_menu_file_submenu(GtkAccelGroup *group)
 {
diff --git a/gtk/scaffolding.c b/gtk/scaffolding.c
index 7e6692a3c..b204dbe28 100644
--- a/gtk/scaffolding.c
+++ b/gtk/scaffolding.c
@@ -1729,8 +1729,9 @@ static void nsgtk_attach_menu_handlers(struct nsgtk_scaffolding *g)
 /**
  * Create and connect handlers to popup menu.
  *
- * \param g scaffoliding to attach popup menu to.
- * \return menu structure on sucess or NULL on error.
+ * \param g scaffolding to attach popup menu to.
+ * \param group The accelerator group to use for the popup.
+ * \return menu structure on success or NULL on error.
  */
 static struct nsgtk_popup_menu *
 nsgtk_new_scaffolding_popup(struct nsgtk_scaffolding *g, GtkAccelGroup *group)
@@ -1767,7 +1768,8 @@ nsgtk_new_scaffolding_popup(struct nsgtk_scaffolding *g, GtkAccelGroup *group)
 /**
  * Create and connect handlers to link popup menu.
  *
- * \param g scaffoliding to attach popup menu to.
+ * \param g scaffolding to attach popup menu to.
+ * \param group The accelerator group to use for the popup.
  * \return true on success or false on error.
  */
 static struct nsgtk_link_menu *
@@ -2418,7 +2420,7 @@ nsgtk_scaffolding_set_websearch(struct nsgtk_scaffolding *g, const char *content
  * GTK UI callback when search provider details are updated.
  *
  * \param provider_name The providers name.
- * \param ico_bitmap The icon bitmap representing the provider.
+ * \param provider_bitmap The bitmap representing the provider.
  * \return NSERROR_OK on success else error code.
  */
 static nserror
-- 
cgit v1.2.3