[goffice] [doc] patch some of the gtk-doc errors

[Jody Goldberg <jody src gnome org>]

commit 0f8623e249fdd2032d96aacc2c15c2c6ddbe82cc
Author: Jody Goldberg <jody gnome org>
Date:   Sun May 3 13:09:31 2009 -0400

    [doc] patch some of the gtk-doc errors
---
 docs/reference/tmpl/gog-object.sgml |   12 ------------
 goffice/graph/gog-chart-map-3d.c    |    2 +-
 goffice/graph/gog-graph.c           |    2 ++
 goffice/graph/gog-guru.c            |    8 +++++---
 goffice/gtk/goffice-gtk.c           |    6 +++---
 goffice/math/go-cspline.c           |    2 ++
 goffice/utils/go-file.c             |   10 +++++++---
 7 files changed, 20 insertions(+), 22 deletions(-)

diff --git a/docs/reference/tmpl/gog-object.sgml b/docs/reference/tmpl/gog-object.sgml
index b500ac4..69a0b86 100644
--- a/docs/reference/tmpl/gog-object.sgml
+++ b/docs/reference/tmpl/gog-object.sgml
@@ -54,9 +54,6 @@ Base class for all objects of graph model
 
 </para>
 
-@: 
-@:
-
 @gogobject: the object which received the signal.
 @arg1: 
 
@@ -73,9 +70,6 @@ Base class for all objects of graph model
 
 </para>
 
-@: 
-@:
-
 @gogobject: the object which received the signal.
 @arg1: 
 
@@ -92,8 +86,6 @@ Base class for all objects of graph model
 
 </para>
 
-@:
-
 @gogobject: the object which received the signal.
 
 <!-- ##### SIGNAL GogObject::name-changed ##### -->
@@ -101,8 +93,6 @@ Base class for all objects of graph model
 
 </para>
 
-@:
-
 @gogobject: the object which received the signal.
 
 <!-- ##### SIGNAL GogObject::update-editor ##### -->
@@ -110,8 +100,6 @@ Base class for all objects of graph model
 
 </para>
 
-@:
-
 @gogobject: the object which received the signal.
 
 <!-- ##### ARG GogObject:alignment ##### -->
diff --git a/goffice/graph/gog-chart-map-3d.c b/goffice/graph/gog-chart-map-3d.c
index 0848918..ff810ed 100644
--- a/goffice/graph/gog-chart-map-3d.c
+++ b/goffice/graph/gog-chart-map-3d.c
@@ -131,10 +131,10 @@ gog_chart_map_3d_new (GogChart *chart, GogViewAllocation const *area,
  * @z: data y value
  * @u: placeholder for x converted value
  * @v: placeholder for y converted value
+ * @w: placeholder for z converted value
  *
  * Converts a 3D coordinate from data space to canvas space.
  **/
-
 void
 gog_chart_map_3d_to_view (GogChartMap3D *map, double x, double y, double z, double *u, double *v, double *w)
 {
diff --git a/goffice/graph/gog-graph.c b/goffice/graph/gog-graph.c
index 560228a..4d1dcae 100644
--- a/goffice/graph/gog-graph.c
+++ b/goffice/graph/gog-graph.c
@@ -666,6 +666,8 @@ cb_graph_idle (GogGraph *graph)
  * @graph : #GogGraph
  *
  * queue an update if one had not already be queued.
+ *
+ * Returns: %TRUE if a handler has been added.
  **/
 gboolean
 gog_graph_request_update (GogGraph *graph)
diff --git a/goffice/graph/gog-guru.c b/goffice/graph/gog-guru.c
index 858dc72..21233f9 100644
--- a/goffice/graph/gog-guru.c
+++ b/goffice/graph/gog-guru.c
@@ -1238,7 +1238,9 @@ graph_guru_init (GraphGuruState *s)
  *
  * Quick utility to allow application specific help.  Required until we clean
  * up the relationship between goffice and gnumeric to decide which parts of
- * the hlpe live where.
+ * the help live where.
+ *
+ * Returns: #GtkWidget associated with the gurus help button.
  **/
 GtkWidget *
 gog_guru_get_help_button (GtkWidget *guru)
@@ -1252,13 +1254,13 @@ gog_guru_get_help_button (GtkWidget *guru)
  * @graph	: the graph to edit
  * @dalloc	: The data allocator to use for editing
  * @cc		: Where to report errors
- * @closure	:
+ * @closure	: #GClosure
  *
  * CHANGED 0.5.3
  * 	: drop the @toplevel window argument and have the callers handle
  * 	  widget_show and set_transient
  *
- * Returns: and shows new graph guru.
+ * Returns: the dialog, and shows new graph guru.
  **/
 GtkWidget *
 gog_guru (GogGraph *graph, GogDataAllocator *dalloc,
diff --git a/goffice/gtk/goffice-gtk.c b/goffice/gtk/goffice-gtk.c
index fd3e4a1..e688287 100644
--- a/goffice/gtk/goffice-gtk.c
+++ b/goffice/gtk/goffice-gtk.c
@@ -104,8 +104,8 @@ go_gtk_dialog_add_button (GtkDialog *dialog, char const* text, char const* stock
 /**
  * go_glade_new :
  * @gladefile : the name of the file load
- * @root :
- * @domain :
+ * @root : Name of the root object
+ * @domain : The translation domain
  * @gcc : #GOCmdContext
  *
  * Simple utility to open glade files
@@ -194,7 +194,7 @@ go_glade_signal_connect_swapped (GladeXML	*gui,
 /**
  * go_xml_builder_new :
  * @uifile : the name of the file load
- * @domain :
+ * @domain : the translation domain
  * @gcc : #GOCmdContext
  *
  * Simple utility to open ui files
diff --git a/goffice/math/go-cspline.c b/goffice/math/go-cspline.c
index 7a1f0c7..9c2abd3 100644
--- a/goffice/math/go-cspline.c
+++ b/goffice/math/go-cspline.c
@@ -211,6 +211,7 @@ void SUFFIX(go_cspline_destroy) (struct SUFFIX(GOCSpline) *sp)
 /**
  * go_cspline_get_value:
  * @sp: a spline structure returned by go_cspline_init.
+ * @x : The value
  *
  * sp must be a valid spline structure as returned by go_cspline_init.
  *
@@ -248,6 +249,7 @@ DOUBLE SUFFIX(go_cspline_get_value) (struct SUFFIX(GOCSpline) *sp, DOUBLE x)
 /**
  * go_cspline_get_deriv:
  * @sp: a spline structure returned by go_cspline_init.
+ * @x : the value
  *
  * sp must be a valid spline structure as returned by go_cspline_init.
  *
diff --git a/goffice/utils/go-file.c b/goffice/utils/go-file.c
index a00b7e4..fcc98d8 100644
--- a/goffice/utils/go-file.c
+++ b/goffice/utils/go-file.c
@@ -464,6 +464,8 @@ go_shell_arg_to_uri (char const *arg)
  *
  * Decode the final path component.  Returns as UTF-8 encoded suitable
  * for display.
+ *
+ * Returns: a string that the caller is responsible for freeing.
  **/
 char *
 go_basename_from_uri (char const *uri)
@@ -481,6 +483,8 @@ go_basename_from_uri (char const *uri)
  *
  * Decode the all but the final path component.  Returns as UTF-8 encoded
  * suitable for display.
+ *
+ * Returns: dirname which the caller is responsible for freeing.
  **/
 char *
 go_dirname_from_uri (char const *uri, gboolean brief)
@@ -891,7 +895,7 @@ go_file_get_date_changed (char const *uri)
 
 /**
  * go_url_decode:
- * @text :
+ * @text : constant buffer to decode.
  *
  * Decode the result of go_url_encode.
  *
@@ -927,8 +931,8 @@ go_url_decode (gchar const *text)
 
 /**
  * go_url_encode:
- * @text :
- * @type :
+ * @text : The constant text to be encoded
+ * @type : 0 : mailto, 1: file or http
  *
  * url-encode a string according to RFC 2368.
  *