GNOME.org
 

[goffice] Moved some structs from gnumeric and fix some documentation warnings.

commit baa3f32b59c5cbb9572f660192cfef2bb3208f62
Author: Jean Brefort <jean brefort normalesup org>
Date:   Sun Aug 12 21:00:27 2012 +0200

    Moved some structs from gnumeric and fix some documentation warnings.

 docs/reference/goffice-0.8-sections.txt | 3196 -------------------------------
 docs/reference/goffice-docs.xml         |   13 +-
 goffice/app/error-info.c                |    6 +
 goffice/app/file.c                      |   45 +
 goffice/app/go-doc-impl.h               |    2 +
 goffice/app/go-doc.c                    |   12 +
 goffice/app/go-doc.h                    |   15 -
 goffice/app/go-plugin.c                 |   11 +
 goffice/component/go-component.c        |    9 +
 goffice/component/go-component.h        |    1 +
 goffice/graph/gog-reg-curve.c           |   16 +
 goffice/graph/gog-renderer.c            |    5 +-
 goffice/graph/gog-series-labels.c       |   21 +
 goffice/graph/gog-series.c              |   47 +
 goffice/graph/gog-smoothed-curve.c      |    7 +
 goffice/graph/gog-styled-object.c       |    5 +
 goffice/graph/gog-view.c                |   35 +
 goffice/graph/gog-view.h                |    1 +
 goffice/gtk/go-action-combo-pixmaps.c   |    7 +
 goffice/gtk/go-action-combo-text.c      |    7 +
 goffice/utils/datetime.c                |   25 +
 goffice/utils/go-bezier.c               |    8 +
 goffice/utils/go-bezier.h               |    5 +-
 goffice/utils/go-editor.c               |   14 +
 goffice/utils/go-format.c               |    4 +-
 goffice/utils/go-undo.c                 |    4 +-
 goffice/utils/goffice-utils.h           |   32 +-
 goffice/utils/regutf8.c                 |   20 +
 28 files changed, 350 insertions(+), 3223 deletions(-)
---
diff --git a/docs/reference/goffice-docs.xml b/docs/reference/goffice-docs.xml
index a0e84df..541418f 100644
--- a/docs/reference/goffice-docs.xml
+++ b/docs/reference/goffice-docs.xml
@@ -24,6 +24,7 @@
 			<xi:include href="xml/gog-error-bar.xml"/>
 			<xi:include href="xml/gog-label.xml"/>
 			<xi:include href="xml/gog-reg-eqn.xml"/>
+			<xi:include href="xml/gog-series-labels.xml"/>
 			<xi:include href="xml/gog-series-lines.xml"/>
 		</chapter>
 		<chapter>
@@ -125,12 +126,19 @@
 		<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"/>
 		</chapter>
 		<chapter>
+			<title>Images</title>
+			<xi:include href="xml/go-image.xml"/>
+			<xi:include href="xml/go-pixbuf.xml"/>
+			<xi:include href="xml/go-svg.xml"/>
+			<xi:include href="xml/go-emf.xml"/>
+			<xi:include href="xml/go-spectre.xml"/>
+		</chapter>
+		<chapter>
 			<title>Data</title>
 			<xi:include href="xml/go-data.xml"/>
 			<xi:include href="xml/go-data-scalar.xml"/>
@@ -170,6 +178,7 @@
 			<xi:include href="xml/go-plugin-loader.xml"/>
 			<xi:include href="xml/go-plugin-loader-module.xml"/>
 			<xi:include href="xml/go-plugin-service.xml"/>
+			<xi:include href="xml/go-view.xml"/>
 <!--		<xi:include href="xml/go-service.xml"/>	-->
 		</chapter>
 		<chapter>
@@ -179,6 +188,7 @@
 		</chapter>
 		<chapter>
 			<title>Miscellaneous</title>
+			<xi:include href="xml/datetime.xml"/>
 			<xi:include href="xml/go-reg.xml"/>
 			<xi:include href="xml/go-search-replace.xml"/>
 			<xi:include href="xml/go-format.xml"/>
@@ -219,7 +229,6 @@
 <xi:include href="xml/go-marshal.xml"/>
 <xi:include href="xml/goffice-gtk.xml"/>
 <xi:include href="xml/go-ms-parser.xml"/>
-<xi:include href="xml/datetime.xml"/>
 <xi:include href="xml/format-impl.xml"/>
 <xi:include href="xml/go-file.xml"/>
 <xi:include href="xml/go-marshalers.xml"/>
diff --git a/goffice/app/error-info.c b/goffice/app/error-info.c
index f53ea8a..83bfa87 100644
--- a/goffice/app/error-info.c
+++ b/goffice/app/error-info.c
@@ -26,6 +26,12 @@
 #include <stdio.h>
 #include <errno.h>
 
+/**
+ * GOSeverity:
+ * @GO_WARNING: warning.
+ * @GO_ERROR: error.
+**/
+
 struct _GOErrorInfo {
 	gchar *msg;
 	GOSeverity severity;
diff --git a/goffice/app/file.c b/goffice/app/file.c
index 36c8e93..59d1253 100644
--- a/goffice/app/file.c
+++ b/goffice/app/file.c
@@ -40,6 +40,42 @@
 #include <string.h>
 #include <glib/gi18n-lib.h>
 
+/**
+ * GOFileFormatLevel:
+ * @GO_FILE_FL_NONE: no name assigned, won't happen.
+ * @GO_FILE_FL_WRITE_ONLY: PostScript etc, won't be remembered.
+ * @GO_FILE_FL_NEW: Wb just created.
+ * @GO_FILE_FL_MANUAL: Save gets punted to save as.
+ * @GO_FILE_FL_MANUAL_REMEMBER: Ditto, but remember in history.
+ * @GO_FILE_FL_AUTO: Save will save to this filename.
+ * @GO_FILE_FL_LAST: last value, won't happen.
+ **/
+
+/**
+ * GOFileSaveScope:
+ * @GO_FILE_SAVE_WORKBOOK: save the whole file.
+ * @GO_FILE_SAVE_SHEET: save only current page.
+ * @GO_FILE_SAVE_RANGE: save only a selected range.
+ * @GO_FILE_SAVE_LAST: last value, won't happen.
+ **/
+
+/**
+ * GOFileProbeLevel:
+ * @GO_FILE_PROBE_FILE_NAME: test only file name, don't read file contents.
+ * @GO_FILE_PROBE_CONTENT: read the whole file if it's necessary.
+ * @GO_FILE_PROBE_LAST: last value, won't happen.
+ **/
+
+/**
+ * GOFileOpenerClass:
+ * @parent_class: parent class.
+ * @can_probe: returns %TRUE if the files can be probed.
+ * @probe: probes the file.
+ * @open: opens and reads the file.
+ *
+ * File opener base class.
+ **/
+
 static void
 go_file_opener_init (GOFileOpener *fo)
 {
@@ -327,6 +363,15 @@ go_file_opener_open (GOFileOpener const *fo, gchar const *opt_enc,
  * GOFileSaver
  */
 
+/**
+ * GOFileSaverClass:
+ * @parent_class: parent class.
+ * @save: saves the file.
+ * @set_export_options: set the options.
+ *
+ * File saver base class.
+ **/
+
 static void
 go_file_saver_init (GOFileSaver *fs)
 {
diff --git a/goffice/app/go-doc-impl.h b/goffice/app/go-doc-impl.h
index e5cf84c..a804164 100644
--- a/goffice/app/go-doc-impl.h
+++ b/goffice/app/go-doc-impl.h
@@ -34,6 +34,8 @@ struct _GODoc {
 	gint64           first_modification_time;
 	gboolean	 pristine;
 	GHashTable	*images;
+
+	/* private */
 	GHashTable	*imagebuf; /* used when loading/saving images */
 };
 
diff --git a/goffice/app/go-doc.c b/goffice/app/go-doc.c
index 6cf4d4e..13d7b19 100644
--- a/goffice/app/go-doc.c
+++ b/goffice/app/go-doc.c
@@ -31,6 +31,18 @@
 
 #include <string.h>
 
+/**
+ * _GODoc:
+ * @base: parent object.
+ * @uri: URI.
+ * @meta_data: metadata.
+ * @modified: whether the document has been modified.
+ * @first_modification_time: date of the firs modification.
+ * @pristine: whether the document is unchanged since it was created.
+ * @images: images used inside the document.
+ * @imagebuf: used when loading/saving images.
+**/
+
 enum {
 	PROP_0,
 	PROP_URI,
diff --git a/goffice/app/go-doc.h b/goffice/app/go-doc.h
index 398bc9a..d866fdf 100644
--- a/goffice/app/go-doc.h
+++ b/goffice/app/go-doc.h
@@ -48,21 +48,6 @@ GsfDocMetaData	*go_doc_get_meta_data	 (GODoc const *doc);
 void		 go_doc_set_meta_data	 (GODoc *doc, GsfDocMetaData *data);
 void		 go_doc_update_meta_data (GODoc *doc);
 
-#if 0
-GODoc   *go_doc_new_from_input  (GsfInput *input,
-				 GODocImporter const *fmt,
-				 XXXGOIOContext *context,
-				 gchar const *encoding);
-GODoc   *go_doc_new_from_uri	(char const *uri,
-				 GnmFileOpener const *fmt,
-				 XXXGOIOContext *context,
-				 gchar const *encoding);
-gboolean go_doc_save		(GODoc *doc, XXXGOIOContext *context);
-gboolean go_doc_save_as		(GODoc *doc, GODocExporter *fmt, char const *uri,
-				 XXXGOIOContext *cc);
-gboolean go_doc_sendto		(GODoc *doc, XXXGOIOContext *cc);
-#endif
-
 /* put into GODoc (as properties) */
 
 /* Images related functions */
diff --git a/goffice/app/go-plugin.c b/goffice/app/go-plugin.c
index 947643e..43f371b 100644
--- a/goffice/app/go-plugin.c
+++ b/goffice/app/go-plugin.c
@@ -58,6 +58,17 @@
 #include <unistd.h>
 #endif
 
+/**
+ * GOPluginModuleDepend:
+ * @key: object being versioned.
+ * @version: version id (strict equality is required).
+ **/
+/**
+ * GOPluginModuleHeader:
+ * @magic_number: magic GOffice plugins number.
+ * @num_depends: number of #GOPluginModuleDepend fields.
+ **/
+
 #define PLUGIN_INFO_FILE_NAME          "plugin.xml"
 #define PLUGIN_ID_VALID_CHARS          "_ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"
 
diff --git a/goffice/component/go-component.c b/goffice/component/go-component.c
index fe308bd..7b8218c 100644
--- a/goffice/component/go-component.c
+++ b/goffice/component/go-component.c
@@ -67,6 +67,15 @@ go_snapshot_type_from_string (char const *name)
  * @set_size: sets the requested size.
  * @render: displays the contents.
  * @changed: callback called when the component contents changed.
+ * @set_font: sets the default font for the component.
+ * @reserved1: reserved for future use.
+ * @reserved2: reserved for future use.
+ * @reserved3: reserved for future use.
+ * @reserved4: reserved for future use.
+ * @reserved_signal1: reserved for future use.
+ * @reserved_signal2: reserved for future use.
+ * @reserved_signal3: reserved for future use.
+ * @reserved_signal4: reserved for future use.
  *
  * The component base object class.
  **/
diff --git a/goffice/component/go-component.h b/goffice/component/go-component.h
index 38fcaa4..471f85f 100644
--- a/goffice/component/go-component.h
+++ b/goffice/component/go-component.h
@@ -70,6 +70,7 @@ struct _GOComponentClass {
 	void (*render) (GOComponent *component, cairo_t *cr,
 			    double width, double height);
 	void (*set_font) (GOComponent *component, PangoFontDescription *desc);
+	/* private */
 	void (*reserved1) (void);
 	void (*reserved2) (void);
 	void (*reserved3) (void);
diff --git a/goffice/graph/gog-reg-curve.c b/goffice/graph/gog-reg-curve.c
index 957664d..73e17eb 100644
--- a/goffice/graph/gog-reg-curve.c
+++ b/goffice/graph/gog-reg-curve.c
@@ -25,6 +25,22 @@
 #include <gsf/gsf-impl-utils.h>
 #include <glib/gi18n-lib.h>
 
+/**
+ * GogRegCurveDrawingBounds:
+ * @GOG_REG_CURVE_DRAWING_BOUNDS_NONE: no limits.
+ * @GOG_REG_CURVE_DRAWING_BOUNDS_ABSOLUTE: absolute limits.
+ * @GOG_REG_CURVE_DRAWING_BOUNDS_RELATIVE: limits relative to the data range.
+ **/
+
+/**
+ * GogRegCurveClass:
+ * @get_value_at: returns the calculated value.
+ * @get_equation: gets the regresion equation as a string.
+ * @populate_editor: populates the editor.
+ * @reserved1: reserved for future use.
+ * @reserved2: reserved for future use.
+ **/
+
 #define GOG_REG_CURVE_GET_CLASS(o)	(G_TYPE_INSTANCE_GET_CLASS ((o), GOG_TYPE_REG_CURVE, GogRegCurveClass))
 
 static GObjectClass *reg_curve_parent_klass;
diff --git a/goffice/graph/gog-renderer.c b/goffice/graph/gog-renderer.c
index f63095e..ff18391 100644
--- a/goffice/graph/gog-renderer.c
+++ b/goffice/graph/gog-renderer.c
@@ -840,6 +840,7 @@ gog_renderer_draw_marker (GogRenderer *rend, double x, double y)
  * @str: the #GOString to draw
  * @pos: #GogViewAllocation
  * @anchor: #GOAnchorType how to draw relative to @pos
+ * @justification: #GtkJustification for multiline string.
  * @width: if positive, the maximum width to get a multiline string if needed.
  *
  * Have @rend draw @layout in the at @pos.{x,y} anchored by the @anchor corner.
@@ -944,8 +945,10 @@ gog_renderer_draw_gostring (GogRenderer *rend, GOString *str,
  * @rend: #GogRenderer
  * @text: the string to draw
  * @pos: #GogViewAllocation
- * @anchor: #GtkAnchorType how to draw relative to @pos
+ * @anchor: #GOAnchorType how to draw relative to @pos
  * @use_markup: wether to use pango markup
+ * @justification: #GtkJustification for multiline text.
+ * @width: if positive, the maximum width to get a multiline text if needed.
  *
  * Have @rend draw @text in the at @pos.{x,y} anchored by the @anchor corner.
  * If @pos.w or @pos.h are >= 0 then clip the results to less than that size.
diff --git a/goffice/graph/gog-series-labels.c b/goffice/graph/gog-series-labels.c
index a8f83bc..28a8400 100644
--- a/goffice/graph/gog-series-labels.c
+++ b/goffice/graph/gog-series-labels.c
@@ -28,6 +28,27 @@
 static GObjectClass *data_label_parent_klass;
 static GObjectClass *series_labels_parent_klass;
 
+/**
+ * GogSeriesLabelElt:
+ * @str: the string to display.
+ * @legend_pos: the label position.
+ * @point: #GogObject
+} 
+**/
+
+/**
+ * GogSeriesLabelsPos:
+ * @GOG_SERIES_LABELS_DEFAULT_POS: default position.
+ * @GOG_SERIES_LABELS_CENTERED: centered.
+ * @GOG_SERIES_LABELS_TOP: at top.
+ * @GOG_SERIES_LABELS_BOTTOM: at bottom.
+ * @GOG_SERIES_LABELS_LEFT: at left.
+ * @GOG_SERIES_LABELS_RIGHT: at right.
+ * @GOG_SERIES_LABELS_OUTSIDE: outside the element.
+ * @GOG_SERIES_LABELS_INSIDE: inside the element.
+ * @GOG_SERIES_LABELS_NEAR_ORIGIN: near origin.
+ **/
+
 struct {
 	char const *label;
 	GogSeriesLabelsPos pos;
diff --git a/goffice/graph/gog-series.c b/goffice/graph/gog-series.c
index f5e75f2..4ee44b3 100644
--- a/goffice/graph/gog-series.c
+++ b/goffice/graph/gog-series.c
@@ -28,6 +28,53 @@
 #include <string.h>
 
 /**
+ * GogSeriesFillType:
+ * @GOG_SERIES_FILL_TYPE_Y_ORIGIN: from origin ox the X-axis.
+ * @GOG_SERIES_FILL_TYPE_X_ORIGIN: from the origin of the Y-axis
+ * @GOG_SERIES_FILL_TYPE_BOTTOM: from the chart bottom.
+ * @GOG_SERIES_FILL_TYPE_LEFT: from the chart left side.
+ * @GOG_SERIES_FILL_TYPE_TOP: from the chart top.
+ * @GOG_SERIES_FILL_TYPE_RIGHT:, from the chart right side.
+ * @GOG_SERIES_FILL_TYPE_ORIGIN: from the origin (for radar and polar plots).
+ * @GOG_SERIES_FILL_TYPE_CENTER: from the center (for radar and polar plots).
+ * @GOG_SERIES_FILL_TYPE_EDGE: from the edge (for radar and polar plots).
+ * @GOG_SERIES_FILL_TYPE_SELF: close the series curve and fills it.
+ * @GOG_SERIES_FILL_TYPE_NEXT: from next series.
+ * @GOG_SERIES_FILL_TYPE_X_AXIS_MIN: from X-axis minimum.
+ * @GOG_SERIES_FILL_TYPE_X_AXIS_MAX: from X-axis maximum.
+ * @GOG_SERIES_FILL_TYPE_Y_AXIS_MIN: from Y-axis minimum.
+ * @GOG_SERIES_FILL_TYPE_Y_AXIS_MAX: from Y-axis maximum.
+ * @GOG_SERIES_FILL_TYPE_INVALID: invalid, should not happen.
+ **/
+
+/**
+ * GogSeriesClass:
+ * @has_interpolation: supports interpolation.
+ * @has_fill_type: %TRUE if filling is supported.
+ * @valid_fill_type_list: list of supported #GogSeriesFillType values.
+ * @series_element_type: #GType for the series element if supported.
+ * @dim_changed: called when data changed for the series.
+ * @get_xy_data: get X and Y data.
+ * @get_interpolation_params: get interpolation parameters if any, only applies
+ * to constrained cubic spline interpolation.
+ **/
+
+/**
+ * GogSeriesElementClass:
+ * @gse_populate_editor: populates editor.
+ **/
+
+/**
+ * GogSeriesPriority:
+ * @GOG_SERIES_REQUIRED: it must be there.
+ * @GOG_SERIES_SUGGESTED: allocator will fill it in, but use need not.
+ * @GOG_SERIES_OPTIONAL: optional data.
+ * @GOG_SERIES_ERRORS: optional data for error bars.
+ *
+ * Applies to data declarations in #GogSeriesDimDesc.
+ **/
+
+/**
  * SECTION: gog-series
  * @short_description: A single data series.
  *
diff --git a/goffice/graph/gog-smoothed-curve.c b/goffice/graph/gog-smoothed-curve.c
index 7fb7d29..e93b5b9 100644
--- a/goffice/graph/gog-smoothed-curve.c
+++ b/goffice/graph/gog-smoothed-curve.c
@@ -29,6 +29,13 @@ static GType gog_smoothed_curve_view_get_type (void);
 
 static GObjectClass *smoothed_curve_parent_klass;
 
+/**
+ * GogSmoothedCurveClass:
+ * @base: base class.
+ * @max_dim: number of #GOData parameters.
+ *
+ * Base class for smoothed curves.
+ **/
 #ifdef GOFFICE_WITH_GTK
 static void
 gog_smoothed_curve_populate_editor (GogObject	*gobj,
diff --git a/goffice/graph/gog-styled-object.c b/goffice/graph/gog-styled-object.c
index f11949f..231f6b6 100644
--- a/goffice/graph/gog-styled-object.c
+++ b/goffice/graph/gog-styled-object.c
@@ -49,6 +49,11 @@ GSF_CLASS (GogStyle, gog_style,
 	   NULL, NULL,
 	   GO_TYPE_STYLE);
 
+/**
+ * GogStyledObjectClass:
+ * @init_style: intiializes the style.
+ **/
+
 static void gog_styled_object_style_changed (GOStyledObject *obj);
 
 static gulong gog_styled_object_signals [LAST_SIGNAL] = { 0, };
diff --git a/goffice/graph/gog-view.c b/goffice/graph/gog-view.c
index d434e22..e00c5bb 100644
--- a/goffice/graph/gog-view.c
+++ b/goffice/graph/gog-view.c
@@ -25,6 +25,20 @@
 #include <gsf/gsf-impl-utils.h>
 #include <glib/gi18n-lib.h>
 
+/**
+ * GogViewClass:
+ * @state_init: state intialization.
+ * @padding_request: padding request.
+ * @size_request: size request.
+ * @size_allocate: size allocate.
+ * @render: render to cairo.
+ * @build_toolkit: builds the associated toolkit.
+ * @get_tip_at_point: gets tip at pointer position.
+ * @natural_size: gets natural size.
+ * @reserved1: reserved for future use.
+ * @reserved2: reserved for future use.
+ **/
+
 static GogViewAllocation *
 gog_view_allocation_copy (GogViewAllocation *alloc)
 {
@@ -49,6 +63,18 @@ gog_view_allocation_get_type (void)
 
 /*****************************************************************************/
 
+/**
+ * GogTool:
+ * @name: tool name.
+ * @cursor_type: pointer cursor type for the tool.
+ * @point: points an object.
+ * @render: displays the tool.
+ * @init: initalizes an action.
+ * @move: callback for pointer move.
+ * @double_click: callback on double click.
+ * @destroy: destroys the action.
+ **/
+
 #ifdef GOFFICE_WITH_GTK
 static gboolean
 gog_tool_select_object_point (GogView *view, double x, double y, GogObject **gobj)
@@ -206,6 +232,15 @@ static GogTool gog_tool_resize_object = {
 
 /*****************************************************************************/
 
+/**
+ * GogToolAction:
+ * @start_x: initial pointer horizontal position.
+ * @start_y: initial pointer vertical position.
+ * @view: #GogView
+ * @tool: #GogTool
+ * @data: user data.
+ **/
+
 static GogToolAction *
 gog_tool_action_ref (GogToolAction *action)
 {
diff --git a/goffice/graph/gog-view.h b/goffice/graph/gog-view.h
index d1eee45..2350adf 100644
--- a/goffice/graph/gog-view.h
+++ b/goffice/graph/gog-view.h
@@ -48,6 +48,7 @@ struct _GogToolAction {
 	GogView 	*view;
 	GogTool 	*tool;
 	gpointer	 data;
+	/* private */
 	unsigned ref_count;
 };
 
diff --git a/goffice/gtk/go-action-combo-pixmaps.c b/goffice/gtk/go-action-combo-pixmaps.c
index f826d51..f2b3b54 100644
--- a/goffice/gtk/go-action-combo-pixmaps.c
+++ b/goffice/gtk/go-action-combo-pixmaps.c
@@ -27,6 +27,13 @@
 #include <gsf/gsf-impl-utils.h>
 #include <glib/gi18n-lib.h>
 
+/**
+ * GOActionComboPixmapsElement:
+ * @untranslated_tooltip: the element tooltip.
+ * @stock_id: icon identifier.
+ * @id: pixmap identifier.
+ **/
+
 typedef struct {
 	GtkToolItem	 base;
 	GOComboPixmaps	*combo;	/* container has a ref, not us */
diff --git a/goffice/gtk/go-action-combo-text.c b/goffice/gtk/go-action-combo-text.c
index 2884071..dec49b9 100644
--- a/goffice/gtk/go-action-combo-text.c
+++ b/goffice/gtk/go-action-combo-text.c
@@ -26,6 +26,13 @@
 #include <gsf/gsf-impl-utils.h>
 #include <glib/gi18n-lib.h>
 
+/**
+ * GOActionComboTextSearchDir:
+ * @GO_ACTION_COMBO_SEARCH_FROM_TOP: search from the top of the list.
+ * @GO_ACTION_COMBO_SEARCH_CURRENT: search from the current selection.
+ * @GO_ACTION_COMBO_SEARCH_NEXT: search from the next element after current.
+ **/
+
 /*****************************************************************************/
 
 struct _GOActionComboText {
diff --git a/goffice/utils/datetime.c b/goffice/utils/datetime.c
index 93d2138..78a4a2d 100644
--- a/goffice/utils/datetime.c
+++ b/goffice/utils/datetime.c
@@ -33,6 +33,31 @@
 #define SECS_PER_DAY (24 * 60 * 60)
 #define HALF_SEC (0.5 / SECS_PER_DAY)
 
+/**
+ * GODateConventions:
+ * @use_1904: use MacOffice 1904 based date convention,
+ * rather than the Win32 style 1900.
+ **/
+
+/**
+ * GoCouponConvention:
+ * @freq: frequency.
+ * @basis: #go_basis_t
+ * @eom: end of month.
+ * @date_conv: #GODateConventions
+ **/
+
+/**
+ * go_basis_t:
+ * @GO_BASIS_MSRB_30_360: US 30/360 (days in a month/days in a year)
+ * @GO_BASIS_ACT_ACT: actual days/actual days
+ * @GO_BASIS_ACT_360: actual days/360
+ * @GO_BASIS_ACT_365: actual days/365
+ * @GO_BASIS_30E_360: European 30/360
+ * @GO_BASIS_30Ep_360: ?
+ * @GO_BASIS_MSRB_30_360_SYM: ?
+ **/
+
 /* ------------------------------------------------------------------------- */
 static GODateConventions *
 go_date_conventions_copy (GODateConventions const *dc)
diff --git a/goffice/utils/go-bezier.c b/goffice/utils/go-bezier.c
index 5c2f709..f1f49c9 100644
--- a/goffice/utils/go-bezier.c
+++ b/goffice/utils/go-bezier.c
@@ -24,6 +24,14 @@
 #include <goffice/math/go-math.h>
 
 /**
+ * GOBezierSpline:
+ * @x: control points abscissa.
+ * @y: control points ordinates.
+ * @n: spline segments number.
+ * @closed: whether the curve is closed.
+ **/
+
+/**
  * go_bezier_spline_init:
  * @x: the x values
  * @y: the y values
diff --git a/goffice/utils/go-bezier.h b/goffice/utils/go-bezier.h
index dc9aca7..bcb71be 100644
--- a/goffice/utils/go-bezier.h
+++ b/goffice/utils/go-bezier.h
@@ -26,12 +26,13 @@
 
 G_BEGIN_DECLS
 
-typedef struct {
+struct  _GOBezierSpline {
 	double *x, *y;
 	int n;
 	gboolean closed;
+	/* private */
 	unsigned ref_count;
-} GOBezierSpline;
+};
 
 GType go_bezier_spline_get_type (void);
 GOBezierSpline *go_bezier_spline_init (double const *x, double const *y, int n,
diff --git a/goffice/utils/go-editor.c b/goffice/utils/go-editor.c
index 4301f29..59bcd13 100644
--- a/goffice/utils/go-editor.c
+++ b/goffice/utils/go-editor.c
@@ -26,6 +26,20 @@
 #include <string.h>
 
 /**
+ * _GOEditor:
+ * @store_page: pointer to a place for storing last edited page.
+ * @pages: list of #GOEditorPage.
+ * @registered_widgets: registered wigets.
+ * @ref_count: reference counter.
+ **/
+
+/**
+ * GOEditorPage:
+ * @label: label for notebook page.
+ * @widget: notebook page.
+ **/
+
+/**
  * go_editor_new:
  *
  * Returns: (transfer full): a new GOEditor object, which is used to store a collection of
diff --git a/goffice/utils/go-format.c b/goffice/utils/go-format.c
index 7cb617e..424874e 100644
--- a/goffice/utils/go-format.c
+++ b/goffice/utils/go-format.c
@@ -4820,7 +4820,7 @@ SUFFIX(go_render_general) (PangoLayout *layout, GString *str,
  * @go_color: a color to rende
  * @col_width: intended max width of layout in pango units.  -1 means
  *             no restriction.
- * @date_conv: #GODateConv
+ * @date_conv: #GODateConventions
  * @unicode_minus: Use unicode minuses, not hyphens.
  *
  * Render a floating-point value into @layout in such a way that the
@@ -4841,7 +4841,7 @@ SUFFIX(go_render_general) (PangoLayout *layout, GString *str,
  * @go_color: a color to rende
  * @col_width: intended max width of layout in pango units.  -1 means
  *             no restriction.
- * @date_conv: #GODateConv
+ * @date_conv: #GODateConventions
  * @unicode_minus: Use unicode minuses, not hyphens.
  *
  * Render a floating-point value into @layout in such a way that the
diff --git a/goffice/utils/go-undo.c b/goffice/utils/go-undo.c
index 873eb11..7c88352 100644
--- a/goffice/utils/go-undo.c
+++ b/goffice/utils/go-undo.c
@@ -63,8 +63,8 @@ go_undo_undo (GOUndo *u)
 
 /**
  * go_undo_combine:
- * @a: optional first undo operation
- * @b: optional last undo operation
+ * @a: (transfer full): optional first undo operation
+ * @b: (transfer full): optional last undo operation
  *
  * This function takes ownership of the argument references and gives ownership
  * of the result to the caller.  Either argument may be NULL in which case the
diff --git a/goffice/utils/goffice-utils.h b/goffice/utils/goffice-utils.h
index 42a975d..3fd313b 100644
--- a/goffice/utils/goffice-utils.h
+++ b/goffice/utils/goffice-utils.h
@@ -27,7 +27,8 @@
 G_BEGIN_DECLS
 
 typedef guint32					GOColor;
-typedef struct _GOEditor                GOEditor;
+typedef struct _GOBezierSpline  GOBezierSpline;
+typedef struct _GOEditor        GOEditor;
 typedef struct _GOFont			GOFont;
 typedef struct _GOFontMetrics	GOFontMetrics;
 typedef struct _GOPattern		GOPattern;
@@ -39,8 +40,8 @@ typedef struct _GOPixbuf		GOPixbuf;
 typedef struct _GOSvg			GOSvg;
 typedef struct _GOEmf			GOEmf;
 typedef struct _GOSpectre		GOSpectre;
-typedef struct _GOPath GOPath;
-typedef struct _GOString GOString;
+typedef struct _GOPath          GOPath;
+typedef struct _GOString        GOString;
 typedef struct _GOStyle			GOStyle;
 typedef struct _GOStyledObject	GOStyledObject;
 
@@ -102,6 +103,31 @@ typedef enum
   GO_ANCHOR_E		= GO_ANCHOR_EAST
 } GOAnchorType;
 
+typedef enum {
+	GOD_ANCHOR_DIR_UNKNOWN    = 0xFF,
+	GOD_ANCHOR_DIR_UP_LEFT    = 0x00,
+	GOD_ANCHOR_DIR_UP_RIGHT   = 0x01,
+	GOD_ANCHOR_DIR_DOWN_LEFT  = 0x10,
+	GOD_ANCHOR_DIR_DOWN_RIGHT = 0x11,
+
+	GOD_ANCHOR_DIR_NONE_MASK  = 0x00,
+	GOD_ANCHOR_DIR_H_MASK	  = 0x01,
+	GOD_ANCHOR_DIR_RIGHT	  = 0x01,
+	GOD_ANCHOR_DIR_V_MASK	  = 0x10,
+	GOD_ANCHOR_DIR_DOWN	  = 0x10
+} GODrawingAnchorDir;
+
+typedef struct _GODrawingAnchor {
+	int			pos_pts [4];	/* position in points */
+	GODrawingAnchorDir	direction;
+} GODrawingAnchor;
+
+typedef enum {
+	GO_FONT_SCRIPT_SUB	= -1,
+	GO_FONT_SCRIPT_STANDARD =  0,
+	GO_FONT_SCRIPT_SUPER	=  1
+} GOFontScript;
+
 G_END_DECLS
 
 #include <goffice/goffice.h>
diff --git a/goffice/utils/regutf8.c b/goffice/utils/regutf8.c
index 143483d..c3e6cb8 100644
--- a/goffice/utils/regutf8.c
+++ b/goffice/utils/regutf8.c
@@ -28,6 +28,16 @@
 #include <string.h>
 
 /* ------------------------------------------------------------------------- */
+/**
+ * GORegexp:
+ * @re_nsub: number of capturing subpatterns.
+ **/
+
+/**
+ * GORegmatch:
+ * @rm_so: start offset.
+ * @rm_eo: end offset.
+ **/
 
 void
 go_regfree (GORegexp *gor)
@@ -727,6 +737,16 @@ go_search_replace_get_property (GObject     *object,
 }
 
 /* ------------------------------------------------------------------------- */
+/**
+ * GOSearchReplace:
+ * @search_text: string to replace.
+ * @replace_text: string to use as replacement/
+ * @comp_search: #GORegexp
+ * @is_regexp: search text is a regular expression.
+ * @ignore_case: consider "a" and "A" the same.
+ * @preserve_case: like Emacs' case-replace.
+ * @match_words: like grep -w.
+ **/
 
 static void
 go_search_replace_set_search_text (GOSearchReplace *sr, const char *text)
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]