GNOME.org
 

[goffice] Fixed some introspection and doc warnings.

commit a880086066c266b9bdbc447314ee2797cbaebb2c
Author: Jean Brefort <jean brefort normalesup org>
Date:   Wed Aug 1 17:47:09 2012 +0200

    Fixed some introspection and doc warnings.

 ChangeLog                           |    4 ++++
 docs/reference/goffice-docs.xml     |   14 ++++++++------
 goffice/app/go-doc.c                |    9 ++++++---
 goffice/canvas/goc-group.c          |    8 ++++----
 goffice/component/go-component.c    |    2 --
 goffice/component/go-component.h    |    2 +-
 goffice/goffice.c                   |   16 +++++++++++-----
 goffice/graph/gog-grid-line.c       |    2 ++
 goffice/graph/gog-grid-line.h       |    2 --
 goffice/graph/gog-outlined-object.h |    5 ++++-
 goffice/gtk/go-combo-pixmaps.c      |    8 +++++++-
 goffice/gtk/go-combo-pixmaps.h      |    1 +
 goffice/gtk/go-format-sel.c         |   12 ++++++++++++
 goffice/gtk/go-graph-widget.c       |   12 ++++++------
 goffice/utils/go-font.c             |   14 ++++++++++++++
 goffice/utils/go-font.h             |    1 +
 16 files changed, 81 insertions(+), 31 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 2dc6f33..14bd687 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2012-08-01  Jean Brefort  <jean brefort normalesup org>
 
+	* all: fixed some introspection and doc warnings.
+
+2012-08-01  Jean Brefort  <jean brefort normalesup org>
+
 	* configure.in: requires gtk-doc >= 1.12.
 	* docs/reference/goffice-docs.sgml: replaced by xml.
 	* docs/reference/goffice-docs.xml: replaces sgml.
diff --git a/docs/reference/goffice-docs.xml b/docs/reference/goffice-docs.xml
index 78a8e6f..1e21ef8 100644
--- a/docs/reference/goffice-docs.xml
+++ b/docs/reference/goffice-docs.xml
@@ -9,9 +9,7 @@
 		<title>Goffice Reference Manual</title>
 		<releaseinfo>For goffice &version;</releaseinfo>
 	</bookinfo>
-	<chapter>
-		<xi:include href="xml/goffice.xml"/>
-	</chapter>
+	<xi:include href="xml/goffice.xml"/>
 	<part>
 		<title>Graphs</title>
 		<chapter>
@@ -33,6 +31,7 @@
 			<xi:include href="xml/gog-object.xml"/>
 			<xi:include href="xml/gog-styled-object.xml"/>
 			<xi:include href="xml/gog-outlined-object.xml"/>
+			<xi:include href="xml/gog-plot-impl.xml"/>
 			<xi:include href="xml/gog-plot.xml"/>
 			<xi:include href="xml/gog-series.xml"/>
 			<xi:include href="xml/gog-trend-line.xml"/>
@@ -100,7 +99,6 @@
 			<xi:include href="xml/go-calendar-button.xml"/>
 			<xi:include href="xml/go-color-group.xml"/>
 			<xi:include href="xml/go-combo-color.xml"/>
-			<xi:include href="xml/go-combo-text.xml"/>
 			<xi:include href="xml/go-charmap-sel.xml"/>
 			<xi:include href="xml/go-font-sel.xml"/>
 			<xi:include href="xml/go-format-sel.xml"/>
@@ -146,7 +144,7 @@
 			<xi:include href="xml/go-cspline.xml"/>
 			<xi:include href="xml/go-distribution.xml"/>
 			<xi:include href="xml/go-fft.xml"/>
-			<xi:include href="xml/go-range.xml"/>
+			<xi:include href="xml/go-rangefunc.xml"/>
 			<xi:include href="xml/go-regression.xml"/>
 			<xi:include href="xml/go-units.xml"/>
 		</chapter>
@@ -185,9 +183,13 @@
 			<xi:include href="xml/go-persist.xml"/>
 			<xi:include href="xml/go-undo.xml"/>
 			<xi:include href="xml/go-string.xml"/>
-			<xi:include href="xml/go-utils.xml"/>
+			<xi:include href="xml/goffice-utils.xml"/>
 		</chapter>
 	</part>
+	<index id="gsf-index">
+		<title id="index-all">Index</title>
+		<xi:include href="xml/tree_index.sgml"/>
+	</index>
 	<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 </book>
 <!--
diff --git a/goffice/app/go-doc.c b/goffice/app/go-doc.c
index 7645f7c..ed2736a 100644
--- a/goffice/app/go-doc.c
+++ b/goffice/app/go-doc.c
@@ -369,7 +369,8 @@ go_doc_update_meta_data (GODoc *doc)
 	g_signal_emit (G_OBJECT (doc), signals [METADATA_UPDATE], 0);
 }
 
-/** go_doc_get_image:
+/**
+ * go_doc_get_image:
  * @doc: a #GODoc
  * @id: the image name
  *
@@ -384,7 +385,8 @@ go_doc_get_image (GODoc *doc, char const *id)
 		NULL;
 }
 
-/** go_doc_add_image:
+/**
+ * go_doc_add_image:
  * @doc: a #GODoc
  * @id: the image name or NULL
  * @image: a #GOImage
@@ -567,7 +569,8 @@ go_doc_end_read	(GODoc *doc)
 	doc->imagebuf = NULL;
 }
 
-/** go_doc_image_fetch:
+/**
+ * go_doc_image_fetch:
  * @doc: a #GODoc
  * @id: the name for the new image.
  *
diff --git a/goffice/canvas/goc-group.c b/goffice/canvas/goc-group.c
index db733d9..d3707ca 100644
--- a/goffice/canvas/goc-group.c
+++ b/goffice/canvas/goc-group.c
@@ -420,7 +420,7 @@ goc_group_adjust_coords (GocGroup const *group, double *x, double *y)
 }
 
 /**
- * goc_group_cairo_transform:
+ * goc_group_cairo_transform: (skip)
  * @group: #GocGroup
  * @cr: #cairo_t
  * @x: horizontal coordinate
@@ -453,9 +453,9 @@ goc_group_cairo_transform (GocGroup const *group, cairo_t *cr, double x, double
 
 /**
  * goc_group_set_clip_path: (skip)
- * group: #GocGroup
- * clip_path: #GOPath
- * clip_rule: #cairo_fill_rule_t
+ * @group: #GocGroup
+ * @clip_path: #GOPath
+ * @clip_rule: #cairo_fill_rule_t
  *
  * Clips the drawing inside @path.
  */
diff --git a/goffice/component/go-component.c b/goffice/component/go-component.c
index eceb67d..00a38ad 100644
--- a/goffice/component/go-component.c
+++ b/goffice/component/go-component.c
@@ -65,8 +65,6 @@ go_snapshot_type_from_string (char const *name)
  * @set_data: sets the data embedded in the component.
  * @set_default_size: sets the default size for the component.
  * @set_size: sets the requested size.
- * @set_window: sets the window if the component uses a #GdkWindow. The new
- * window is stored in the @window field of #GOComponent.
  * @render: displays the contents.
  * @changed: callback called when the component contents changed.
  *
diff --git a/goffice/component/go-component.h b/goffice/component/go-component.h
index 0e55a10..38fcaa4 100644
--- a/goffice/component/go-component.h
+++ b/goffice/component/go-component.h
@@ -44,7 +44,7 @@ struct _GOComponent {
 	char *mime_type;
 	double width, ascent, descent, height;
 	double default_width, default_ascent, default_descent;
-	gboolean needs_window, resizable, editable;
+	gboolean resizable, editable;
 	char const *data;
 	GDestroyNotify destroy_notify;
 	gpointer destroy_data;
diff --git a/goffice/goffice.c b/goffice/goffice.c
index 10b316b..9cad131 100644
--- a/goffice/goffice.c
+++ b/goffice/goffice.c
@@ -55,7 +55,7 @@ static char const *libgoffice_extern_plugin_dir = GOFFICE_EXTERNPLUGINDIR;
 
 /**
  * SECTION: goffice
- * @Title: GOffice
+ * @Title: Gettings Started with GOffice
  *
  * GOffice is a #GObject based C library. It provides easy API access to
  * creating and manipulating graphs and canvases. See #GogGraph and #GocCanvas.
@@ -78,18 +78,24 @@ static char const *libgoffice_extern_plugin_dir = GOFFICE_EXTERNPLUGINDIR;
  * </informalexample>
  * GOffice provides a pkg-config metadata file named
  * "libgoffice-$major.$minor.pc", where $major and $minor denote which version
- * GOffice is. So to link against GOffice 0.8 series, use:
+ * GOffice is. So to link against GOffice 0.10 series, use:
  * <informalexample>
  * <programlisting>
- * pkg-config --libs libgoffice-0.8
+ * pkg-config --libs libgoffice-0.10
  * </programlisting>
  * </informalexample>
  *
  * API and ABI compatability is maintained per minor release series, e.g:
  * all 0.8.x releases are ABI/API compatible with previous 0.8.x releases.
  *
- * As of September 2010, there are no bindings for other languages
- * than C available.
+ * Bindings for other languages than C and C++ are available through GObject
+ * Introspection. To start using GOffice from Python:
+ * <informalexample>
+ * <programlisting>
+ * from gi.repository import GOffice
+ * GOffice.init()
+ * </programlisting>
+ * </informalexample>
  */
 
 gchar const *
diff --git a/goffice/graph/gog-grid-line.c b/goffice/graph/gog-grid-line.c
index 8fc6a82..0ae3c58 100644
--- a/goffice/graph/gog-grid-line.c
+++ b/goffice/graph/gog-grid-line.c
@@ -27,6 +27,8 @@
 #include <gsf/gsf-impl-utils.h>
 #include <math.h>
 
+typedef GogView GogGridLineView;
+
 struct _GogGridLine {
 	GogStyledObject	base;
 
diff --git a/goffice/graph/gog-grid-line.h b/goffice/graph/gog-grid-line.h
index c7ef82c..93432d4 100644
--- a/goffice/graph/gog-grid-line.h
+++ b/goffice/graph/gog-grid-line.h
@@ -34,8 +34,6 @@ GType gog_grid_line_get_type (void);
 
 gboolean gog_grid_line_is_minor (GogGridLine *ggl);
 
-typedef GogView GogGridLineView;
-
 void gog_grid_line_view_render_stripes (GogView *view);
 void gog_grid_line_view_render_lines (GogView *view);
 
diff --git a/goffice/graph/gog-outlined-object.h b/goffice/graph/gog-outlined-object.h
index b8d82ee..08fe511 100644
--- a/goffice/graph/gog-outlined-object.h
+++ b/goffice/graph/gog-outlined-object.h
@@ -41,7 +41,10 @@ double gog_outlined_object_get_pad  (GogOutlinedObject const *goo);
 
 /****************************************************************************/
 
-typedef GogView		GogOutlinedView;
+typedef struct {
+	GogView base;
+} GogOutlinedView;
+
 typedef struct {
 	GogViewClass	base;
 	gboolean	call_parent_render;
diff --git a/goffice/gtk/go-combo-pixmaps.c b/goffice/gtk/go-combo-pixmaps.c
index 455cab3..ab8fab4 100644
--- a/goffice/gtk/go-combo-pixmaps.c
+++ b/goffice/gtk/go-combo-pixmaps.c
@@ -285,6 +285,12 @@ go_combo_pixmaps_get_selected (GOComboPixmaps const *combo, int *index)
 	return el->id;
 }
 
+/**
+ * go_combo_pixmaps_get_preview:
+ * @combo: #GOComboPixmaps
+ * 
+ * Returns: (transfer none): the preview button.
+ **/
 GtkWidget *
 go_combo_pixmaps_get_preview (GOComboPixmaps const *combo)
 {
@@ -317,7 +323,7 @@ go_menu_pixmaps_class_init (GObjectClass *gobject_class)
 			      G_TYPE_NONE, 1, G_TYPE_INT);
 }
 
-static GSF_CLASS (GOMenuPixmaps, go_menu_pixmaps,
+GSF_CLASS (GOMenuPixmaps, go_menu_pixmaps,
 		  go_menu_pixmaps_class_init, NULL,
 		  GTK_TYPE_MENU)
 
diff --git a/goffice/gtk/go-combo-pixmaps.h b/goffice/gtk/go-combo-pixmaps.h
index e526ead..8cbade2 100644
--- a/goffice/gtk/go-combo-pixmaps.h
+++ b/goffice/gtk/go-combo-pixmaps.h
@@ -46,6 +46,7 @@ gboolean   go_combo_pixmaps_select_id    (GOComboPixmaps *combo, int id);
 int        go_combo_pixmaps_get_selected (GOComboPixmaps const *combo, int *index);
 GtkWidget *go_combo_pixmaps_get_preview	 (GOComboPixmaps const *combo);
 
+GType      go_menu_pixmaps_get_type	 (void);
 GOMenuPixmaps *go_menu_pixmaps_new	 (int ncols);
 void       go_menu_pixmaps_add_element   (GOMenuPixmaps *menu,
 					  GdkPixbuf *pixbuf, int id);
diff --git a/goffice/gtk/go-format-sel.c b/goffice/gtk/go-format-sel.c
index 6f82641..b17727f 100644
--- a/goffice/gtk/go-format-sel.c
+++ b/goffice/gtk/go-format-sel.c
@@ -1836,6 +1836,12 @@ go_format_sel_set_dateconv (GOFormatSel *gfs,
 	draw_format_preview (gfs, TRUE);
 }
 
+/**
+ * go_format_sel_get_fmt:
+ * @gfs: #GOFormatSel
+ * 
+ * Returns: (transfer none): the #GOFormat.
+ **/
 GOFormat const *
 go_format_sel_get_fmt (GOFormatSel *gfs)
 {
@@ -1843,6 +1849,12 @@ go_format_sel_get_fmt (GOFormatSel *gfs)
 	return gfs->format.spec;
 }
 
+/**
+ * go_format_sel_get_dateconv:
+ * @gfs: #GOFormatSel
+ * 
+ * Returns: (transfer none): the #GODateConventions.
+ **/
 GODateConventions const *
 go_format_sel_get_dateconv (GOFormatSel *gfs)
 {
diff --git a/goffice/gtk/go-graph-widget.c b/goffice/gtk/go-graph-widget.c
index c2a6e47..ba997f3 100644
--- a/goffice/gtk/go-graph-widget.c
+++ b/goffice/gtk/go-graph-widget.c
@@ -461,8 +461,8 @@ GSF_CLASS (GOGraphWidget, go_graph_widget,
 	   gtk_layout_get_type ())
 
 /**
- * go_graph_widget_get_graph :
- * @widget : #GOGraphWidget
+ * go_graph_widget_get_graph:
+ * @widget: #GOGraphWidget
  *
  * Returns: (transfer none): the #GogGraph embedded in the widget.
  **/
@@ -474,8 +474,8 @@ go_graph_widget_get_graph (GOGraphWidget *widget)
 }
 
 /**
- * go_graph_widget_get_chart :
- * @widget : #GOGraphWidget
+ * go_graph_widget_get_chart:
+ * @widget: #GOGraphWidget
  *
  * Returns: (transfer none): the #GogChart created by go_graph_widget_new().
  **/
@@ -488,8 +488,8 @@ go_graph_widget_get_chart (GOGraphWidget *widget)
 }
 
 /**
- * go_graph_widget_get_renderer :
- * @widget : #GOGraphWidget
+ * go_graph_widget_get_renderer:
+ * @widget: #GOGraphWidget
  *
  * Returns: (transfer none): the #GogRenderer used by the widget.
  **/
diff --git a/goffice/utils/go-font.c b/goffice/utils/go-font.c
index c3bc28d..c31ac0c 100644
--- a/goffice/utils/go-font.c
+++ b/goffice/utils/go-font.c
@@ -33,6 +33,20 @@ static GOFont const	*font_default;
 #define ref_debug(x)	do { } while (0)
 #endif
 
+GType
+go_font_get_type (void)
+{
+	static GType type = 0;
+
+	if (type == 0)
+		type = g_boxed_type_register_static
+			("GOFont",
+			 (GBoxedCopyFunc) go_font_ref,
+			 (GBoxedFreeFunc) go_font_unref);
+
+    return type;
+}
+
 static void
 go_font_free (GOFont *font)
 {
diff --git a/goffice/utils/go-font.h b/goffice/utils/go-font.h
index c8b1547..0679e0d 100644
--- a/goffice/utils/go-font.h
+++ b/goffice/utils/go-font.h
@@ -55,6 +55,7 @@ struct _GOFont {
 	GOColor color;
 };
 
+GType         go_font_get_type (void);
 GOFont const *go_font_new_by_desc  (PangoFontDescription *desc);
 GOFont const *go_font_new_by_name  (char const *str);
 GOFont const *go_font_new_by_index (unsigned i);
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]