GNOME.org
 

[goffice] fixed more gtk-doc warnings

commit 6f0a75b746d162eaa22803db84b5d9f01959865a
Author: Jean Brefort <jean brefort normalesup org>
Date:   Sun Jan 17 10:34:12 2010 +0100

    fixed more gtk-doc warnings

 docs/reference/goffice-0.8-sections.txt |   12 +++++++++++
 docs/reference/goffice-docs.sgml        |    4 +++
 goffice/canvas/goc-canvas.c             |    2 +-
 goffice/graph/gog-error-bar.c           |    8 +++++++
 goffice/graph/gog-label.c               |   21 +------------------
 goffice/graph/gog-label.h               |   20 ++++++++++++++++++
 goffice/graph/gog-series.c              |    2 +-
 goffice/utils/go-line.c                 |   33 +++++++++++++++++++++++++++++++
 goffice/utils/go-path.c                 |    7 ++++++
 9 files changed, 87 insertions(+), 22 deletions(-)
---
diff --git a/docs/reference/goffice-0.8-sections.txt b/docs/reference/goffice-0.8-sections.txt
index ce65779..3994780 100644
--- a/docs/reference/goffice-0.8-sections.txt
+++ b/docs/reference/goffice-0.8-sections.txt
@@ -494,6 +494,7 @@ gog_smoothed_curve_get_type
 GogErrorBar
 GogErrorBarType
 GogErrorBarDisplay
+GogErrorBarDirection
 gog_error_bar_dup
 gog_error_bar_prefs
 gog_error_bar_get_bounds
@@ -537,6 +538,15 @@ gog_label_get_type
 </SECTION>
 
 <SECTION>
+<FILE>gog-text</FILE>
+<TITLE>GogText</TITLE>
+GogText
+gog_text_get_str
+<SUBSECTION Private>
+gog_text_get_type
+</SECTION>
+
+<SECTION>
 <FILE>gog-reg-eqn</FILE>
 <TITLE>GogRegEqn</TITLE>
 <INCLUDE>goffice/goffice.h</INCLUDE>
@@ -1762,6 +1772,8 @@ go_marker_selector_set_shape
 </SECTION>
 
 <SECTION>
+<FILE>go-arrow</FILE>
+<TITLE>GOArrow</TITLE>
 GOArrow
 GOArrowType
 go_arrow_clear
diff --git a/docs/reference/goffice-docs.sgml b/docs/reference/goffice-docs.sgml
index b2c0b8d..dc88ccd 100644
--- a/docs/reference/goffice-docs.sgml
+++ b/docs/reference/goffice-docs.sgml
@@ -25,6 +25,7 @@
 			<xi:include href="xml/gog-label.xml"/>
 			<xi:include href="xml/gog-reg-eqn.xml"/>
 			<xi:include href="xml/gog-series-lines.xml"/>
+			<xi:include href="xml/gog-text.xml"/>
 		</chapter>
 		<chapter>
 			<title>Abstract Base Classes</title>
@@ -49,6 +50,7 @@
 			<xi:include href="xml/gog-theme.xml"/>
 			<xi:include href="xml/gog-chart-map.xml"/>
 			<xi:include href="xml/gog-axis-map.xml"/>
+			<xi:include href="xml/gog-3d-box.xml"/>
 		</chapter>
 	</part>
 	<part>
@@ -106,6 +108,7 @@
 		<title>Utilities</title>
 		<chapter>
 			<title>Graphic object properties</title>
+			<xi:include href="xml/go-arrow.xml"/>
 			<xi:include href="xml/go-color.xml"/>
 			<xi:include href="xml/go-editor.xml"/>
 			<xi:include href="xml/go-font.xml"/>
@@ -119,6 +122,7 @@
 		<chapter>
 			<title>Rendering utilities</title>
 			<xi:include href="xml/go-cairo.xml"/>
+			<xi:include href="xml/go-image.xml"/>
 			<xi:include href="xml/go-path.xml"/>
 			<xi:include href="xml/go-geometry.xml"/>
 			<xi:include href="xml/go-bezier.xml"/>
diff --git a/goffice/canvas/goc-canvas.c b/goffice/canvas/goc-canvas.c
index 9a205e2..e661b36 100644
--- a/goffice/canvas/goc-canvas.c
+++ b/goffice/canvas/goc-canvas.c
@@ -36,7 +36,7 @@
 
 /**
  * GocDirection :
- * @GOC_DIRECTION_LTR : Left to rigth direction
+ * @GOC_DIRECTION_LTR : Left to right direction
  * @GOC_DIRECTION_RTL : Right to left direction
  * @GOC_DIRECTION_MAX : First invalid value
  **/
diff --git a/goffice/graph/gog-error-bar.c b/goffice/graph/gog-error-bar.c
index d678e23..312f28d 100644
--- a/goffice/graph/gog-error-bar.c
+++ b/goffice/graph/gog-error-bar.c
@@ -41,6 +41,14 @@
 
 #define CC2XML(s) ((const xmlChar *)(s))
 
+/**
+ * GogErrorBarType :
+ * @GOG_ERROR_BAR_TYPE_NONE: No error bars.
+ * @GOG_ERROR_BAR_TYPE_ABSOLUTE: Absolute errors.
+ * @GOG_ERROR_BAR_TYPE_RELATIVE: Relative errors.
+ * @GOG_ERROR_BAR_TYPE_PERCENT: Relative errors as percent.
+ **/
+
 typedef GObjectClass GogErrorBarClass;
 static GObjectClass *error_bar_parent_klass;
 
diff --git a/goffice/graph/gog-label.c b/goffice/graph/gog-label.c
index 8432b91..a57461d 100644
--- a/goffice/graph/gog-label.c
+++ b/goffice/graph/gog-label.c
@@ -33,25 +33,6 @@ enum {
 	TEXT_PROP_ALLOW_MARKUP
 };
 
-typedef struct {
-	GogOutlinedObject base;
-
-	gboolean	  allow_markup;
-} GogText;
-
-typedef struct {
-	GogOutlinedObjectClass base;
-
-	char *(*get_str)    (GogText *text);
-} GogTextClass;
-
-#define GOG_TYPE_TEXT		(gog_text_get_type ())
-#define GOG_TEXT(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), GOG_TYPE_TEXT, GogText))
-#define GOG_IS_TEXT(o)		(G_TYPE_CHECK_INSTANCE_TYPE ((o), GOG_TYPE_TEXT))
-#define GOG_TEXT_GET_CLASS(o)	(G_TYPE_INSTANCE_GET_CLASS ((o), GOG_TYPE_TEXT, GogTextClass))
-
-static GType gog_text_get_type (void);
-
 static GObjectClass *text_parent_klass;
 
 static void
@@ -139,7 +120,7 @@ gog_text_init (GogText *text)
 	text->allow_markup = FALSE;
 }
 
-static char *
+char *
 gog_text_get_str (GogText *text)
 {
 	GogTextClass *klass;
diff --git a/goffice/graph/gog-label.h b/goffice/graph/gog-label.h
index d2be310..c63a5a2 100644
--- a/goffice/graph/gog-label.h
+++ b/goffice/graph/gog-label.h
@@ -26,6 +26,26 @@
 
 G_BEGIN_DECLS
 
+typedef struct {
+	GogOutlinedObject base;
+
+	gboolean	  allow_markup;
+} GogText;
+
+typedef struct {
+	GogOutlinedObjectClass base;
+
+	char *(*get_str)    (GogText *text);
+} GogTextClass;
+
+#define GOG_TYPE_TEXT		(gog_text_get_type ())
+#define GOG_TEXT(o)		(G_TYPE_CHECK_INSTANCE_CAST ((o), GOG_TYPE_TEXT, GogText))
+#define GOG_IS_TEXT(o)		(G_TYPE_CHECK_INSTANCE_TYPE ((o), GOG_TYPE_TEXT))
+#define GOG_TEXT_GET_CLASS(o)	(G_TYPE_INSTANCE_GET_CLASS ((o), GOG_TYPE_TEXT, GogTextClass))
+
+GType gog_text_get_type (void);
+char *gog_text_get_str (GogText *text);
+
 #define GOG_TYPE_LABEL	(gog_label_get_type ())
 #define GOG_LABEL(o)	(G_TYPE_CHECK_INSTANCE_CAST ((o), GOG_TYPE_LABEL, GogLabel))
 #define GOG_IS_LABEL(o)	(G_TYPE_CHECK_INSTANCE_TYPE ((o), GOG_TYPE_LABEL))
diff --git a/goffice/graph/gog-series.c b/goffice/graph/gog-series.c
index 76c9a4d..534744e 100644
--- a/goffice/graph/gog-series.c
+++ b/goffice/graph/gog-series.c
@@ -962,7 +962,7 @@ gog_series_set_name (GogSeries *series, GODataScalar *name_src, GError **err)
  * @series : #GogSeries
  * @dim_i : Which dimension
  * @val   : #GOData
- * @err : optional #Gerror pointer
+ * @err : optional #GError pointer
  *
  * Absorbs a ref to @val
  **/
diff --git a/goffice/utils/go-line.c b/goffice/utils/go-line.c
index 9f15c66..39d6088 100644
--- a/goffice/utils/go-line.c
+++ b/goffice/utils/go-line.c
@@ -25,6 +25,39 @@
 #include <string.h>
 #include <glib/gi18n-lib.h>
 
+/**
+ * GOLineDashType
+ * @GO_LINE_NONE: No line displayed.
+ * @GO_LINE_SOLID: Solid line.
+ * @GO_LINE_S_DOT:
+ * @GO_LINE_S_DASH_DOT:
+ * @GO_LINE_S_DASH_DOT_DOT:
+ * @GO_LINE_DASH_DOT_DOT_DOT:
+ * @GO_LINE_DOT:
+ * @GO_LINE_S_DASH:
+ * @GO_LINE_DASH:
+ * @GO_LINE_LONG_DASH:
+ * @GO_LINE_DASH_DOT:
+ * @GO_LINE_DASH_DOT_DOT:
+ * @GO_LINE_MAX:
+ **/
+
+/**
+ * GOLineInterpolation
+ * @GO_LINE_INTERPOLATION_LINEAR: Linear interpolation.
+ * @GO_LINE_INTERPOLATION_SPLINE: Bezier cubic spline interpolation.
+ * @GO_LINE_INTERPOLATION_CLOSED_SPLINE: Closed Bezier cubic spline interpolation.
+ * @GO_LINE_INTERPOLATION_CUBIC_SPLINE: Cubic spline interpolation with natural limits.
+ * @GO_LINE_INTERPOLATION_PARABOLIC_CUBIC_SPLINE: Cubic spline interpolation with parabolic limits.
+ * @GO_LINE_INTERPOLATION_CUBIC_CUBIC_SPLINE: Cubic spline interpolation with cubic limits.
+ * @GO_LINE_INTERPOLATION_CLAMPED_CUBIC_SPLINE: Cubic spline interpolation with fixed derivatives at both ends.
+ * @GO_LINE_INTERPOLATION_STEP_START: Steps using first y value.
+ * @GO_LINE_INTERPOLATION_STEP_END: Steps using last y value.
+ * @GO_LINE_INTERPOLATION_STEP_CENTER_X: Steps centered around each point.
+ * @GO_LINE_INTERPOLATION_STEP_CENTER_Y: Steps using mean y value.
+ * @GO_LINE_INTERPOLATION_MAX: First invalid value.
+ **/
+
 typedef struct {
 	int 		 n_dash;
 	double		 length;
diff --git a/goffice/utils/go-path.c b/goffice/utils/go-path.c
index 2e13fd0..d908ecb 100644
--- a/goffice/utils/go-path.c
+++ b/goffice/utils/go-path.c
@@ -33,6 +33,13 @@
 #include <goffice/utils/go-cairo.h>
 #include <string.h>
 
+/**
+ * GOPathOptions
+ * @GO_PATH_OPTIONS_SNAP_COORDINATES: round coordinates to avoid aliasing in pixbufs.
+ * @GO_PATH_OPTIONS_SNAP_WIDTH: round width so that it correpond to a round pixels number.
+ * @GO_PATH_OPTIONS_SHARP: use raw coordinates.
+ **/
+
 #define GO_PATH_DEFAULT_BUFFER_SIZE 64
 
 typedef struct _GOPathData	 GOPathData;
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]