[monkey-bubble: 710/753] A bunch of changes to make the existing API documentation build without gtk-doc spitting out warning

[Sven Herzberg <herzi src gnome org>]

commit 627ea1934ed25c0353a04225a0bba6070980e297
Author: Malcolm Tredinnick <malcolm src gnome org>
Date:   Fri May 31 01:40:32 2002 +0000

    A bunch of changes to make the existing API documentation build without gtk-doc
    spitting out warnings everywhere.
    
    	* libgnomeui/gnome-app-helper.c, gnome-app-helper.h,
    	gnome-client.c, gnome-client.h, gnome-color-picker.c,
    	gnome-dateedit.c, gnome-dialog-util.c, gnome-dialog.c,
    	gnome-dialog.h, gnome-druid-page-edge.c,
    	gnome-druid-page-edge.h, gnome-druid-page-standard.h,
    	gnome-druid-page.c, gnome-druid.c, gnome-entry.c,
    	gnome-file-entry.c, gnome-href.c, gnome-icon-entry.c,
    	gnome-icon-list.c, gnome-icon-list.h, gnome-icon-sel.c,
    	gnome-mdi-session.h, gnome-messagebox.c, gnome-messagebox.h,
    	gnome-pixmap-entry.c, gnome-pixmap-entry.h, gnome-popup-menu.c,
    	gnome-scores.c, gnome-scores.h, gnome-ui-init.c, gnome-window.h:
    
    	Lots of little changes to the API documentation comments (adding
    	parameters, removing old no-long-existing parameters, matching
    	variable names between function declarations and definitions).
    	This makes the API docs, such as they are, now build with 250
    	less warnings so that we can detect the real problems.
    
    	* doc/reference/tmpl/gnome-about.sgml, gnome-app-helper.sgml,
    	gnome-client.sgml, gnome-dialog.sgml,
    	gnome-druid-page-edge.sgml, gnome-druid-page-standard.sgml,
    	gnome-gconf-ui.sgml, gnome-href.sgml, gnome-icon-item.sgml,
    	gnome-icon-list.sgml, gnome-marshal.sgml,
    	gnome-mdi-session.sgml, gnome-messagebox.sgml,
    	gnome-pixmap-entry.sgml, gnome-scores.sgml, gnome-uidefs.sgml,
    	gnome-window-icon.sgml, gnome-window.sgml, gnome.sgml,
    	gnometypebuiltins.sgml, libgnomeui-access.sgml,
    	libgnomeui-unused.sgml:
    
    	Changed template files as a result of all the above fixes.
    
    	* doc/reference/libgnomeui-docs.sgml:
    
    	Remove gnome-macros.sgml template, since it's not used any longer.
    
    	* doc/reference/tmpl/gnome-macros.sgml: Removed. Obsolete.
    
    	* doc/reference/libgnomeui-sections.txt:
    
    	A much more complete version of this file. Still not ordered correctly,
    	though.

 libgnomeui/gnome-scores.c |   23 +++--------------------
 libgnomeui/gnome-scores.h |    6 +++---
 2 files changed, 6 insertions(+), 23 deletions(-)
---
diff --git a/libgnomeui/gnome-scores.c b/libgnomeui/gnome-scores.c
index 75def49..672d7d2 100644
--- a/libgnomeui/gnome-scores.c
+++ b/libgnomeui/gnome-scores.c
@@ -148,16 +148,15 @@ gnome_scores_finalize(GObject *object)
 
 /**
  * gnome_scores_construct:
+ * @gs:
  * @n_scores: Number of positions.
  * @names: Names of the players.
  * @scores: Scores
  * @times: Time in which the scores were done
  * @clear: Add a "Clear" Button?
  *
- * Description: useful for language bindings and subclassing, not to be used by itself,
- * see #gnome_scores_new
- *
- * Returns:
+ * Description: useful for language bindings and subclassing, not to be used by
+ * itself, see #gnome_scores_new.
  */
 void
 gnome_scores_construct (  GnomeScores *gs,
@@ -254,8 +253,6 @@ gnome_scores_new (  guint n_scores,
  * @col: Color.
  *
  * Description: Set the color of one entry.
- *
- * Returns:
  */
 void
 gnome_scores_set_color(GnomeScores *gs, guint n, GdkColor *col)
@@ -284,8 +281,6 @@ gnome_scores_set_color(GnomeScores *gs, guint n, GdkColor *col)
  * @col: Color
  *
  * Description: Set the default color of the entries.
- *
- * Returns:
  */
 void
 gnome_scores_set_def_color(GnomeScores *gs, GdkColor *col)
@@ -307,8 +302,6 @@ gnome_scores_set_def_color(GnomeScores *gs, GdkColor *col)
  * @col: Array of colors.
  *
  * Description: Set the color of all the entries.
- *
- * Returns:
  */
 void
 gnome_scores_set_colors(GnomeScores *gs, GdkColor *col)
@@ -330,8 +323,6 @@ gnome_scores_set_colors(GnomeScores *gs, GdkColor *col)
  * @i: Index of the current(from 0 to 9).
  *
  * Description: Set the index of the current player in top ten.
- *
- * Returns:
  */
 void
 gnome_scores_set_current_player (GnomeScores *gs, gint i)
@@ -351,8 +342,6 @@ gnome_scores_set_current_player (GnomeScores *gs, gint i)
  * @txt: Name of the logo.
  *
  * Description: Creates a label to be the logo
- *
- * Returns:
  */
 void
 gnome_scores_set_logo_label_title (GnomeScores *gs, const gchar *txt)
@@ -381,8 +370,6 @@ gnome_scores_set_logo_label_title (GnomeScores *gs, const gchar *txt)
  * @col: Color to use in the label.
  *
  * Description: Creates a label to be the logo
- *
- * Returns:
  */
 void
 gnome_scores_set_logo_label (GnomeScores *gs,
@@ -426,8 +413,6 @@ gnome_scores_set_logo_label (GnomeScores *gs,
  * @w: Widget to be used as logo.
  *
  * Description:  Set an arbitrary widget to be the logo.
- *
- * Returns:
  */
 void
 gnome_scores_set_logo_widget (GnomeScores *gs, GtkWidget *w)
@@ -454,8 +439,6 @@ gnome_scores_set_logo_widget (GnomeScores *gs, GtkWidget *w)
  * @pix_name: filename of a pixmap
  *
  * Description:  Sets the logo on the scores dialog box to a pixmap
- *
- * Returns:
  */
 void
 gnome_scores_set_logo_pixmap (GnomeScores *gs, const gchar *pix_name)
diff --git a/libgnomeui/gnome-scores.h b/libgnomeui/gnome-scores.h
index 77a36e2..f45e9e6 100644
--- a/libgnomeui/gnome-scores.h
+++ b/libgnomeui/gnome-scores.h
@@ -131,13 +131,13 @@ void gnome_scores_set_logo_label (
 		GnomeScores *gs,	/* GNOME Scores widget. */
 		const gchar *txt,	/* Text in the label. */
 		const gchar *font,	/* Font to use in the label. */
-		GdkColor *color		/* Color to use in the label. */
+		GdkColor *col		/* Color to use in the label. */
 		);
 
 /* Creates a pixmap to be the logo */
 void gnome_scores_set_logo_pixmap (
 		GnomeScores *gs,	/* GNOME Scores widget. */
-		const gchar *logo	/* Name of the .xpm. */
+		const gchar *pix_name	/* Name of the .xpm. */
 		);
 
 /* Set an arbitrary widget to be the logo. */
@@ -149,7 +149,7 @@ void gnome_scores_set_logo_widget (
 /* Set the color of one entry. */
 void gnome_scores_set_color (
 		GnomeScores *gs,	/* GNOME Scores widget. */
-		guint pos,		/* Entry to be changed. */
+		guint n,		/* Entry to be changed. */
 		GdkColor *col		/* Color. */
 		);