GNOME.org
 

[goffice] add more documentation entries

commit 35e329ad1c85eec506ffc3a87a29b8746276b483
Author: root <root acer brefort fr>
Date:   Sun Sep 13 20:00:09 2009 +0200

    add more documentation entries

 ChangeLog                               |   12 ++++++
 docs/reference/goffice-0.8-sections.txt |   59 +++++++++++++++++++++++++++++++
 docs/reference/goffice-docs.sgml        |    1 +
 goffice/graph/gog-chart-map.c           |    2 +-
 goffice/gtk/go-3d-rotation-sel.c        |    2 +-
 goffice/gtk/go-3d-rotation-sel.h        |    6 ++--
 goffice/utils/go-bezier.c               |   10 +++---
 goffice/utils/go-bezier.h               |   10 +++---
 8 files changed, 87 insertions(+), 15 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 0838739..53b47dc 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,17 @@
 2009-09-13  Jean Brefort  <jean brefort normalesup org>
 
+	* docs/reference/goffice-0.8-sections.txt: more API doc work.
+	* docs/reference/goffice-docs.sgml: ditto.
+	* goffice/graph/gog-chart-map.c (make_path_spline): make gtk-doc happy.
+	* goffice/gtk/go-3d-rotation-sel.c (go_3d_rotation_sel_new): renamed
+	GO_3D_ROTATION_SEL_TYPE to GO_TYPE_3D_ROTATION_SEL.
+	* goffice/gtk/go-3d-rotation-sel.h: ditto.
+	* goffice/utils/go-bezier.c (go_bezier_spline_init),
+	(go_bezier_spline_destroy), (go_bezier_spline_to_path): make gtk-doc happy.
+	* goffice/utils/go-bezier.h: ditto.
+
+2009-09-13  Jean Brefort  <jean brefort normalesup org>
+
 	* docs/reference/.gitignore: removed goffice-*-sections.txt.
 	* docs/reference/Makefile.am: do not clean goffice-*-sections.txt.
 	* docs/reference/goffice-0.8-sections.txt: added and cleaned a lot.
diff --git a/docs/reference/goffice-0.8-sections.txt b/docs/reference/goffice-0.8-sections.txt
index acb7267..1d49b66 100644
--- a/docs/reference/goffice-0.8-sections.txt
+++ b/docs/reference/goffice-0.8-sections.txt
@@ -1,3 +1,10 @@
+<SECTION>
+<FILE>goffice</FILE>
+GO_VAR_DECL
+libgoffice_init
+libgoffice_shutdown
+</SECTION>
+
 ### Goffice Graph
 
 ### Objects
@@ -832,6 +839,7 @@ go_charmap_sel_get_encoding_name
 
 <SECTION>
 <FILE>go-action-combo-pixmaps</FILE>
+<TITLE>GOActionComboPixmaps</TITLE>
 GO_TYPE_ACTION_COMBO_PIXMAPS
 GO_ACTION_COMBO_PIXMAPS
 GO_IS_ACTION_COMBO_PIXMAPS
@@ -844,7 +852,39 @@ go_action_combo_pixmaps_select_id
 </SECTION>
 
 <SECTION>
+<FILE>go-action-combo-stack</FILE>
+<TITLE>GOActionStack</TITLE>
+GOActionComboStack
+go_action_combo_stack_push
+go_action_combo_stack_pop
+go_action_combo_stack_truncate
+go_action_combo_stack_selection
+<SUBSECTION Standard>
+GO_ACTION_COMBO_STACK
+GO_IS_ACTION_COMBO_STACK
+GO_TYPE_ACTION_COMBO_STACK
+go_action_combo_stack_get_type
+</SECTION>
+
+<SECTION>
+<FILE>go-action-combo-text</FILE>
+<TITLE>GOActionText</TITLE>
+GOActionComboText
+GOActionComboTextSearchDir
+go_action_combo_text_add_item
+go_action_combo_text_set_width
+go_action_combo_text_get_entry
+go_action_combo_text_set_entry
+<SUBSECTION Standard>
+GO_ACTION_COMBO_TEXT
+GO_IS_ACTION_COMBO_TEXT
+GO_TYPE_ACTION_COMBO_TEXT
+go_action_combo_text_get_type
+</SECTION>
+
+<SECTION>
 <FILE>go-action-combo-color</FILE>
+<TITLE>GOActionCOLOR</TITLE>
 GO_TYPE_ACTION_COMBO_COLOR
 GO_ACTION_COMBO_COLOR
 GO_IS_ACTION_COMBO_COLOR
@@ -933,6 +973,24 @@ go_rotation_sel_get_rotation
 </SECTION>
 
 <SECTION>
+<FILE>go-3d-rotation-sel</FILE>
+GO_TYPE_3D_ROTATION_SEL
+GO3DRotationSel
+go_3d_rotation_sel_new
+go_3d_rotation_sel_set_matrix
+go_3d_rotation_sel_set_fov
+go_3d_rotation_sel_get_matrix
+go_3d_rotation_sel_get_psi
+go_3d_rotation_sel_get_theta
+go_3d_rotation_sel_get_phi
+go_3d_rotation_sel_get_fov
+<SUBSECTION Standard>
+GO_3D_ROTATION_SEL
+GO_IS_3D_ROTATION_SEL
+go_3d_rotation_sel_get_type
+</SECTION>
+
+<SECTION>
 <FILE>go-optionmenu</FILE>
 <TITLE>GOOptionMenu</TITLE>
 go_option_menu_new
@@ -1292,6 +1350,7 @@ GORect
 <SECTION>
 <FILE>go-color</FILE>
 <TITLE>GOColor</TITLE>
+GOColor
 GONamedColor
 GO_COLOR_FROM_GDK
 GO_COLOR_FROM_RGB
diff --git a/docs/reference/goffice-docs.sgml b/docs/reference/goffice-docs.sgml
index 369b442..bef4ea8 100644
--- a/docs/reference/goffice-docs.sgml
+++ b/docs/reference/goffice-docs.sgml
@@ -170,6 +170,7 @@
 			<xi:include href="xml/go-libxml-extras.xml"/>
 			<xi:include href="xml/go-persist.xml"/>
 			<xi:include href="xml/go-undo.xml"/>
+			<xi:include href="xml/go-string.xml"/>
 		</chapter>
 	</part>
 </book>
diff --git a/goffice/graph/gog-chart-map.c b/goffice/graph/gog-chart-map.c
index 740d43a..80c89e1 100644
--- a/goffice/graph/gog-chart-map.c
+++ b/goffice/graph/gog-chart-map.c
@@ -250,7 +250,7 @@ make_path_spline (GogChartMap *map,
 	double yy, yy_min, yy_max;
 	gboolean is_inverted;
 	//struct GOCSpline *splinex, *spliney;
-	struct GOBezierSpline *spline;
+	GOBezierSpline *spline;
 
 	path = go_path_new ();
 	if (n_points < 1)
diff --git a/goffice/gtk/go-3d-rotation-sel.c b/goffice/gtk/go-3d-rotation-sel.c
index 079fed2..beb9e6d 100644
--- a/goffice/gtk/go-3d-rotation-sel.c
+++ b/goffice/gtk/go-3d-rotation-sel.c
@@ -433,7 +433,7 @@ GSF_CLASS (GO3DRotationSel, go_3d_rotation_sel,
 GtkWidget *
 go_3d_rotation_sel_new (void)
 {
-	return g_object_new (GO_3D_ROTATION_SEL_TYPE, NULL);
+	return g_object_new (GO_TYPE_3D_ROTATION_SEL, NULL);
 }
 
 void
diff --git a/goffice/gtk/go-3d-rotation-sel.h b/goffice/gtk/go-3d-rotation-sel.h
index 16d58c4..4912171 100644
--- a/goffice/gtk/go-3d-rotation-sel.h
+++ b/goffice/gtk/go-3d-rotation-sel.h
@@ -23,11 +23,11 @@
 
 G_BEGIN_DECLS
 
-#define GO_3D_ROTATION_SEL_TYPE	(go_3d_rotation_sel_get_type ())
+#define GO_TYPE_3D_ROTATION_SEL	(go_3d_rotation_sel_get_type ())
 #define GO_3D_ROTATION_SEL(obj)	(G_TYPE_CHECK_INSTANCE_CAST((obj), \
-                                 GO_3D_ROTATION_SEL_TYPE, GO3DRotationSel))
+                                 GO_TYPE_3D_ROTATION_SEL, GO3DRotationSel))
 #define GO_IS_3D_ROTATION_SEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
-                                    GO_3D_ROTATION_SEL_TYPE))
+                                    GO_TYPE_3D_ROTATION_SEL))
 
 typedef struct _GO3DRotationSel GO3DRotationSel;
 
diff --git a/goffice/utils/go-bezier.c b/goffice/utils/go-bezier.c
index ec87ec7..235cdcf 100644
--- a/goffice/utils/go-bezier.c
+++ b/goffice/utils/go-bezier.c
@@ -39,11 +39,11 @@
  * Returns: a newly created struct GOBezierSpline instance which should be
  * destroyed by a call to go_bezier_spline_destroy.
  **/
-struct GOBezierSpline *
+GOBezierSpline *
 go_bezier_spline_init (double const *x, double const *y, int n, gboolean closed)
 {
 	int i, j, m = n - 1; /* having n-1 in a variable is a little optimization */
-	struct GOBezierSpline *sp;
+	GOBezierSpline *sp;
 	double *a, *b, *c, *d, t;
 
 	/* The equation to solve in the open case is
@@ -70,7 +70,7 @@ go_bezier_spline_init (double const *x, double const *y, int n, gboolean closed)
 	*/
 
 	/* Create and initialize the structure */
-	sp = g_new0 (struct GOBezierSpline, 1);
+	sp = g_new0 (GOBezierSpline, 1);
 	i = (closed)? 3 * n: 3 * n - 2;
 	sp->x = g_new (double, i);
 	sp->y = g_new (double, i);
@@ -304,7 +304,7 @@ go_bezier_spline_init (double const *x, double const *y, int n, gboolean closed)
  * Destroys the given structures after cleaning all allocated fields.
  **/
 void
-go_bezier_spline_destroy (struct GOBezierSpline *sp)
+go_bezier_spline_destroy (GOBezierSpline *sp)
 {
 	g_return_if_fail (sp);
 	g_free (sp->x);
@@ -322,7 +322,7 @@ go_bezier_spline_destroy (struct GOBezierSpline *sp)
  * go_path_free.
  **/
 GOPath *
-go_bezier_spline_to_path (struct GOBezierSpline *sp)
+go_bezier_spline_to_path (GOBezierSpline *sp)
 {
 	int i, j;
 	GOPath *path = go_path_new ();
diff --git a/goffice/utils/go-bezier.h b/goffice/utils/go-bezier.h
index b5f96dc..d2ae01f 100644
--- a/goffice/utils/go-bezier.h
+++ b/goffice/utils/go-bezier.h
@@ -27,17 +27,17 @@
 
 G_BEGIN_DECLS
 
-struct GOBezierSpline {
+typedef struct {
 	double *x, *y;
 	int n;
 	gboolean closed;
-};
+} GOBezierSpline;
 
-struct GOBezierSpline *go_bezier_spline_init (double const *x, double const *y, int n,
+GOBezierSpline *go_bezier_spline_init (double const *x, double const *y, int n,
 				   gboolean closed);
-void go_bezier_spline_destroy (struct GOBezierSpline *sp);
+void go_bezier_spline_destroy (GOBezierSpline *sp);
 
-GOPath *go_bezier_spline_to_path (struct GOBezierSpline *sp);
+GOPath *go_bezier_spline_to_path (GOBezierSpline *sp);
 
 G_END_DECLS
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]