[goffice] Fixed as many documentation warnings as possible.

From: Jean BrÃfort <jbrefort src gnome org>
To: commits-list gnome org
Cc:
Subject: [goffice] Fixed as many documentation warnings as possible.
Date: Thu, 16 Aug 2012 13:44:01 +0000 (UTC)
commit 84fca6c79a5c216d9783f5f45835acdd5ae8ba33
Author: Jean Brefort <jean brefort normalesup org>
Date:   Thu Aug 16 15:43:35 2012 +0200

    Fixed as many documentation warnings as possible.

 ChangeLog                                |    6 ++
 configure.in                             |    7 ++-
 docs/reference/goffice-docs.xml          |    2 +-
 goffice/app/go-cmd-context.c             |    9 ++++
 goffice/app/go-conf.c                    |    1 +
 goffice/app/go-doc-control.c             |   13 +++++
 goffice/app/go-doc.c                     |    1 +
 goffice/component/go-component-factory.c |   10 ++++
 goffice/component/go-component.c         |    8 +++-
 goffice/component/go-component.h         |    1 +
 goffice/data/go-data.c                   |   55 ++++++++++++++++++++++
 goffice/gtk/go-charmap-sel.c             |    6 ++
 goffice/gtk/go-combo-box.c               |    7 +++
 goffice/gtk/go-combo-box.h               |    2 +
 goffice/gtk/go-graph-widget.c            |   11 ++++
 goffice/gtk/go-optionmenu.c              |    1 +
 goffice/math/go-cspline.c                |    8 +++
 goffice/math/go-cspline.h                |    1 +
 goffice/math/go-distribution.c           |    9 ++++
 goffice/utils/datetime.c                 |    8 ++--
 goffice/utils/datetime.h                 |    7 ++-
 goffice/utils/go-color.c                 |    6 ++
 goffice/utils/go-editor.c                |    3 +-
 goffice/utils/go-file.c                  |   20 ++++++++
 goffice/utils/go-format.c                |   74 ++++++++++++++++++++++++++++++
 goffice/utils/go-format.h                |    4 +-
 goffice/utils/go-geometry.c              |   38 +++++++++++++++
 goffice/utils/go-gradient.c              |   21 ++++++++
 goffice/utils/go-image.c                 |   36 ++++++++++++++
 goffice/utils/go-image.h                 |    1 -
 goffice/utils/go-line.c                  |   26 ++++++++++-
 goffice/utils/go-line.h                  |    1 +
 goffice/utils/go-marker.c                |   21 ++++++++
 33 files changed, 406 insertions(+), 18 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 03a0544..ff1a35a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2012-08-16  Jean Brefort  <jean brefort normalesup org>
+
+	* configure.in: requires libgsf-1 >= 1.14.23 for introspection.
+	* docs/reference/goffice-docs.xml: fixed documentation warnings.
+	* all others: ditto.
+
 2012-08-15  Chris Leonard  <cjlhomeaddress gmail com>
 
 	* goffice/gtk/go-format-sel.c: add comments for translators to SI units
diff --git a/configure.in b/configure.in
index c446f6c..8f6d971 100644
--- a/configure.in
+++ b/configure.in
@@ -668,12 +668,13 @@ AS_CASE([$enable_introspection],
 [yes],[
     PKG_CHECK_EXISTS([gobject-introspection-1.0],,
                      AC_MSG_ERROR([gobject-introspection-1.0 is not installed]))
-    PKG_CHECK_EXISTS([gobject-introspection-1.0 >= $GIR_REQ],
+    PKG_CHECK_EXISTS([gobject-introspection-1.0 >= $GIR_REQ libgsf-1 >= 1.14.23],
                      found_introspection=yes,
-                     AC_MSG_ERROR([You need to have gobject-introspection >= $1 installed to build AC_PACKAGE_NAME]))
+                     AC_MSG_ERROR([You need to have gobject-introspection >= $GIR_REQ and libgsf >= 1.14.23 installed to build AC_PACKAGE_NAME]))
 ],
 [auto],[
-    PKG_CHECK_EXISTS([gobject-introspection-1.0 >= $GIR_REQ], found_introspection=yes, found_introspection=no)
+    PKG_CHECK_EXISTS([gobject-introspection-1.0 >= $GIR_REQ libgsf-1 >= 1.14.23],
+                     found_introspection=yes, found_introspection=no)
 dnl Canonicalize enable_introspection
 enable_introspection=$found_introspection
 ],
diff --git a/docs/reference/goffice-docs.xml b/docs/reference/goffice-docs.xml
index ca73886..2e0794b 100644
--- a/docs/reference/goffice-docs.xml
+++ b/docs/reference/goffice-docs.xml
@@ -6,7 +6,7 @@
 ]>
 <book lang="en" id="goffice" xmlns:xi="http://www.w3.org/2003/XInclude";>
 	<bookinfo>
-		<title>Goffice Reference Manual</title>
+		<title>GOffice Reference Manual</title>
 		<releaseinfo>For goffice &version;</releaseinfo>
 	</bookinfo>
 	<xi:include href="xml/goffice.xml"/>
diff --git a/goffice/app/go-cmd-context.c b/goffice/app/go-cmd-context.c
index 377e156..14c970c 100644
--- a/goffice/app/go-cmd-context.c
+++ b/goffice/app/go-cmd-context.c
@@ -27,6 +27,15 @@
 #include <gsf/gsf-impl-utils.h>
 #include <glib/gi18n-lib.h>
 
+/**
+ * GOCmdContextClass:
+ * @base: base interface.
+ * @get_password: retrieves a password.
+ * @set_sensitive: sets sensitivity.
+ * @progress_set: sets the progress value.
+ * @progress_message_set: sets the ptogress message.
+ **/
+
 #define GCC_CLASS(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), GO_TYPE_CMD_CONTEXT, GOCmdContextClass))
 
 static GError *
diff --git a/goffice/app/go-conf.c b/goffice/app/go-conf.c
index 9aca492..0553c51 100644
--- a/goffice/app/go-conf.c
+++ b/goffice/app/go-conf.c
@@ -89,6 +89,7 @@ go_conf_closure_free (GOConfClosure *cls)
  * @data: user data
  *
  * @monitor will be called whenever the value associated with @key changes.
+ * Returns: the signal ID.
  **/
 
 #if defined GOFFICE_WITH_WINREG
diff --git a/goffice/app/go-doc-control.c b/goffice/app/go-doc-control.c
index 1c1f8e7..1b9d799 100644
--- a/goffice/app/go-doc-control.c
+++ b/goffice/app/go-doc-control.c
@@ -25,6 +25,19 @@
 
 #include <gsf/gsf-impl-utils.h>
 
+/**
+ * _GODocControl:
+ * @base: base object.
+ * @doc: #GODoc.
+ **/
+
+/**
+ * GODocControlState:
+ * @GO_DOC_CONTROL_STATE_NORMAL: normal.
+ * @GO_DOC_CONTROL_STATE_FULLSCREEN: full screen.
+ * @GO_DOC_CONTROL_STATE_MAX: maximum value, shoulkd not happen.
+ **/
+
 static void
 go_doc_control_class_init (GObjectClass *klass)
 {
diff --git a/goffice/app/go-doc.c b/goffice/app/go-doc.c
index 13d7b19..5b42045 100644
--- a/goffice/app/go-doc.c
+++ b/goffice/app/go-doc.c
@@ -597,6 +597,7 @@ go_doc_end_read	(GODoc *doc)
  * go_doc_image_fetch:
  * @doc: a #GODoc
  * @id: the name for the new image.
+ * @type: the type of the #GOImage to create if needed.
  *
  * Searches for a #GOImage with name @id in the document image buffer and
  * creates one if needed. The caller does not own a reference on the returned
diff --git a/goffice/component/go-component-factory.c b/goffice/component/go-component-factory.c
index 03331f3..f478bfc 100644
--- a/goffice/component/go-component-factory.c
+++ b/goffice/component/go-component-factory.c
@@ -32,6 +32,16 @@
 
 #include <string.h>
 
+/**
+ * GOMimePriority:
+ * @GO_MIME_PRIORITY_INVALID: no support.
+ * @GO_MIME_PRIORITY_DISPLAY: can display the component.
+ * @GO_MIME_PRIORITY_PRINT: can print the component.
+ * @GO_MIME_PRIORITY_PARTIAL: partial support, including edition.
+ * @GO_MIME_PRIORITY_FULL: full support.
+ * @GO_MIME_PRIORITY_NATIVE: use the native code.
+ **/
+
 static GSList *refd_plugins = NULL;
 
 #define CXML2C(s) ((char const *)(s))
diff --git a/goffice/component/go-component.c b/goffice/component/go-component.c
index 047b2b7..033ca88 100644
--- a/goffice/component/go-component.c
+++ b/goffice/component/go-component.c
@@ -32,6 +32,13 @@
 #include <librsvg/rsvg-cairo.h>
 #include <string.h>
 
+/**
+ * GOSnapshotType:
+ * @GO_SNAPSHOT_NONE: no snapshot.
+ * @GO_SNAPSHOT_SVG: svg snapshot.
+ * @GO_SNAPSHOT_PNG: png snapshot.
+ **/
+
 static struct {
 	GOSnapshotType type;
 	char const *name;
@@ -66,7 +73,6 @@ go_snapshot_type_from_string (char const *name)
  * @set_default_size: sets the default size for the component.
  * @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.
  *
  * The component base object class.
diff --git a/goffice/component/go-component.h b/goffice/component/go-component.h
index f974359..c394fb8 100644
--- a/goffice/component/go-component.h
+++ b/goffice/component/go-component.h
@@ -34,6 +34,7 @@ typedef enum {
 	GO_SNAPSHOT_NONE,
 	GO_SNAPSHOT_SVG,
 	GO_SNAPSHOT_PNG,
+	/* <private> */
 	GO_SNAPSHOT_MAX
 } GOSnapshotType;
 
diff --git a/goffice/data/go-data.c b/goffice/data/go-data.c
index 65fde2a..8aa4568 100644
--- a/goffice/data/go-data.c
+++ b/goffice/data/go-data.c
@@ -29,6 +29,61 @@
 #include <glib/gi18n-lib.h>
 #include <string.h>
 
+/**
+ * GODataFlags:
+ * @GO_DATA_CACHE_IS_VALID: data in cache are valid.
+ * @GO_DATA_IS_EDITABLE: data can be edited.
+ * @GO_DATA_SIZE_CACHED: cached sise is valid.
+ **/
+
+/**
+ * GODataClass:
+ * @base: base class.
+ * @dup: duplicates the #GOData.
+ * @eq: tests if the data are equal.
+ * @preferred_fmt: gets the preferred format.
+ * @date_conv: gets the #GODateConventions.
+ * @serialize: serializes.
+ * @unserialize: unserializes.
+ * @emit_changed: signals the data have changed.
+ * @get_n_dimensions: gets the dimensions number.
+ * @get_sizes: gets the sizes.
+ * @get_values: gets the values.
+ * @get_bounds: gets the bounds.
+ * @get_value: gets a value.
+ * @get_string: gets a string.
+ * @get_markup: gets the #PangoAttrList* for the string.
+ * @is_valid: checks if the data are valid.
+ **/
+
+/**
+ * GODataScalarClass:
+ * @base:  base class.
+ * @get_value: gets the value.
+ * @get_str: gets the string.
+ * @get_markup: gets the #PangoAttrList* for the string.
+ **/
+
+/**
+ * GODataVectorClass:
+ * @base: base class.
+ * @load_len: loads the vector length.
+ * @load_values: loads the values in the cache.
+ * @get_value: gets a value.
+ * @get_str: gets a string.
+ * @get_markup: gets the #PangoAttrList* for the string.
+ **/
+
+/**
+ * GODataMatrixClass:
+ * @base: base class.
+ * @load_size: loads the matrix length.
+ * @load_values: loads the values in the cache.
+ * @get_value: gets a value.
+ * @get_str: gets a string.
+ * @get_markup: gets the #PangoAttrList* for the string.
+ **/
+
 #define GO_DATA_CLASS(k)	(G_TYPE_CHECK_CLASS_CAST ((k), GO_TYPE_DATA, GODataClass))
 #define GO_IS_DATA_CLASS(k)	(G_TYPE_CHECK_CLASS_TYPE ((k), GO_TYPE_DATA))
 #define GO_DATA_GET_CLASS(o)	(G_TYPE_INSTANCE_GET_CLASS ((o), GO_TYPE_DATA, GODataClass))
diff --git a/goffice/gtk/go-charmap-sel.c b/goffice/gtk/go-charmap-sel.c
index 83f346c..97dc0f4 100644
--- a/goffice/gtk/go-charmap-sel.c
+++ b/goffice/gtk/go-charmap-sel.c
@@ -31,6 +31,12 @@
 #include <string.h>
 #include <stdlib.h>
 
+/**
+ * GOCharmapSelTestDirection:
+ * @GO_CHARMAP_SEL_TO_UTF8: to UTF-8.
+ * @GO_CHARMAP_SEL_FROM_UTF8: from UTF-8.
+ **/
+
 #define CS(x) GO_CHARMAP_SEL (x)
 
 #define CHARMAP_NAME_KEY "Name of Character Encoding"
diff --git a/goffice/gtk/go-combo-box.c b/goffice/gtk/go-combo-box.c
index bbe1897..0c9aeb6 100644
--- a/goffice/gtk/go-combo-box.c
+++ b/goffice/gtk/go-combo-box.c
@@ -34,6 +34,13 @@
 
 #include <gsf/gsf-impl-utils.h>
 
+/**
+ * GOComboBoxClass:
+ * @set_title: sets the title.
+ * @pop_down_done: invoked when the popup has been hidden, if the signal
+ * returns %TRUE, it means it should be killed
+ **/
+
 enum {
 	POP_DOWN_DONE,
 	LAST_SIGNAL
diff --git a/goffice/gtk/go-combo-box.h b/goffice/gtk/go-combo-box.h
index 0e54561..40e9aee 100644
--- a/goffice/gtk/go-combo-box.h
+++ b/goffice/gtk/go-combo-box.h
@@ -43,8 +43,10 @@ struct _GOComboBox {
 };
 
 struct _GOComboBoxClass {
+	/* <private> */
 	GtkBoxClass	base;
 
+	/* <public> */
 	/* virtual */
 	void  (*set_title) (GOComboBox *combo, char const *title);
 
diff --git a/goffice/gtk/go-graph-widget.c b/goffice/gtk/go-graph-widget.c
index a0d7aa3..302fc3a 100644
--- a/goffice/gtk/go-graph-widget.c
+++ b/goffice/gtk/go-graph-widget.c
@@ -26,6 +26,17 @@
 
 #include <gsf/gsf-impl-utils.h>
 
+/**
+ * GOGraphWidgetSizeMode:
+ * @GO_GRAPH_WIDGET_SIZE_MODE_FIT: fits the allocated size, conserving the aspect
+ * ratio.
+ * @GO_GRAPH_WIDGET_SIZE_MODE_FIT_WIDTH: fits the width, conserving the aspect
+ * ratio.
+ * @GO_GRAPH_WIDGET_SIZE_MODE_FIT_HEIGHT: fits the width, conserving the aspect
+ * ratio.
+ * @GO_GRAPH_WIDGET_SIZE_MODE_FIXED_SIZE: use original size.
+ **/
+
 static void go_graph_widget_request_update (GOGraphWidget *w);
 
 /**
diff --git a/goffice/gtk/go-optionmenu.c b/goffice/gtk/go-optionmenu.c
index df129d8..00b4f51 100644
--- a/goffice/gtk/go-optionmenu.c
+++ b/goffice/gtk/go-optionmenu.c
@@ -295,6 +295,7 @@ go_option_menu_set_menu (GOOptionMenu *option_menu,
 
 /**
  * go_option_menu_set_history:
+ * @option_menu: #GOOptionMenu
  * @selection: (element-type GtkMenuItem): a list of indices giving the menu to select.
  *
  * Selects an item. The last number in the list is the rank of the item to select
diff --git a/goffice/math/go-cspline.c b/goffice/math/go-cspline.c
index e74d222..a3d0991 100644
--- a/goffice/math/go-cspline.c
+++ b/goffice/math/go-cspline.c
@@ -26,6 +26,14 @@
 #include "go-rangefunc.h"
 #include "go-cspline.h"
 
+/**
+ * GOCSplineType:
+ * @GO_CSPLINE_NATURAL: natural.
+ * @GO_CSPLINE_PARABOLIC: parabolic.
+ * @GO_CSPLINE_CUBIC: cubic.
+ * @GO_CSPLINE_CLAMPED: clamped.
+ **/
+
 #ifndef DOUBLE
 
 #define DOUBLE double
diff --git a/goffice/math/go-cspline.h b/goffice/math/go-cspline.h
index 582ff58..ebc1e42 100644
--- a/goffice/math/go-cspline.h
+++ b/goffice/math/go-cspline.h
@@ -39,6 +39,7 @@ typedef enum {
 	GO_CSPLINE_PARABOLIC,
 	GO_CSPLINE_CUBIC,
 	GO_CSPLINE_CLAMPED,
+	/* <private> */
 	GO_CSPLINE_MAX
 } GOCSplineType;
 
diff --git a/goffice/math/go-distribution.c b/goffice/math/go-distribution.c
index d263ac6..43f851c 100644
--- a/goffice/math/go-distribution.c
+++ b/goffice/math/go-distribution.c
@@ -58,6 +58,15 @@ enum {
 	DIST_PROP_SCALE
 };
 
+/**
+ * GODistributionType:
+ * @GO_DISTRIBUTION_NORMAL: Normal.
+ * @GO_DISTRIBUTION_UNIFORM: Uniform.
+ * @GO_DISTRIBUTION_CAUCHY: Cauchy.,
+ * @GO_DISTRIBUTION_WEIBULL: Weibull.
+ * @GO_DISTRIBUTION_LOGNORMAL: Lognormal.
+ **/
+
 static struct
 {
 	GODistributionType type;
diff --git a/goffice/utils/datetime.c b/goffice/utils/datetime.c
index 78a4a2d..3a2c1fc 100644
--- a/goffice/utils/datetime.c
+++ b/goffice/utils/datetime.c
@@ -42,13 +42,13 @@
 /**
  * GoCouponConvention:
  * @freq: frequency.
- * @basis: #go_basis_t
+ * @basis: #GOBasisType
  * @eom: end of month.
  * @date_conv: #GODateConventions
  **/
 
 /**
- * go_basis_t:
+ * GOBasisType:
  * @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
@@ -409,7 +409,7 @@ days_between_GO_BASIS_30Ep_360 (GDate const *from, GDate const *to)
  *
  * @from      : GDate *
  * @to        : GDate *
- * @basis     : go_basis_t
+ * @basis     : GOBasisType
  * see datetime.h and doc/fn-financial-basis.txt for details
  *
  * @in_order  : dates are considered in order
@@ -419,7 +419,7 @@ days_between_GO_BASIS_30Ep_360 (GDate const *from, GDate const *to)
  */
 
 gint32
-go_date_days_between_basis (GDate const *from, GDate const *to, go_basis_t basis)
+go_date_days_between_basis (GDate const *from, GDate const *to, GOBasisType basis)
 {
 	int sign = 1;
 
diff --git a/goffice/utils/datetime.h b/goffice/utils/datetime.h
index e323579..d7ae4ce 100644
--- a/goffice/utils/datetime.h
+++ b/goffice/utils/datetime.h
@@ -69,13 +69,14 @@ typedef enum { /* see doc/fn-financial-basis.txt for details */
 	GO_BASIS_30E_360         = 4,
 	GO_BASIS_30Ep_360        = 5,
 	GO_BASIS_MSRB_30_360_SYM = 6         /* Gnumeric extension.  */
-} go_basis_t;
+} GOBasisType;
+#define go_basis_t GOBasisType /* for compatibility */
 
-gint32  go_date_days_between_basis (GDate const *from, GDate const *to, go_basis_t basis);
+gint32  go_date_days_between_basis (GDate const *from, GDate const *to, GOBasisType basis);
 
 typedef struct {
 	int	 freq;
-	go_basis_t  basis;
+	GOBasisType  basis;
 	gboolean eom;
 	GODateConventions const *date_conv;
 } GoCouponConvention;
diff --git a/goffice/utils/go-color.c b/goffice/utils/go-color.c
index d37ef50..c8bee8a 100644
--- a/goffice/utils/go-color.c
+++ b/goffice/utils/go-color.c
@@ -26,6 +26,12 @@
 #include <stdio.h>
 
 /**
+ * GONamedColor:
+ * @color: the color.
+ * @name: english name - eg. "white".
+ **/
+
+/**
  * go_color_from_str :
  * @str :
  * @res :
diff --git a/goffice/utils/go-editor.c b/goffice/utils/go-editor.c
index 59bcd13..b8c4732 100644
--- a/goffice/utils/go-editor.c
+++ b/goffice/utils/go-editor.c
@@ -26,11 +26,10 @@
 #include <string.h>
 
 /**
- * _GOEditor:
+ * GOEditor:
  * @store_page: pointer to a place for storing last edited page.
  * @pages: list of #GOEditorPage.
  * @registered_widgets: registered wigets.
- * @ref_count: reference counter.
  **/
 
 /**
diff --git a/goffice/utils/go-file.c b/goffice/utils/go-file.c
index 31b4eb8..f5a835b 100644
--- a/goffice/utils/go-file.c
+++ b/goffice/utils/go-file.c
@@ -49,6 +49,26 @@
 #endif
 #include <time.h>
 
+/**
+ * GOFilePermissions:
+ * @owner_read: owner can read.
+ * @owner_write: owner can write.
+ * @owner_execute: owner can execute.
+ * @group_read: group can read.
+ * @group_write: group can write.
+ * @group_execute: group can execute.
+ * @others_read: everybody can read.
+ * @others_write: everybody can write.
+ * @others_execute: everybody can execute.
+ **/
+
+/**
+ * GODotDot:
+ * @GO_DOTDOT_SYNTACTIC: assume no symlinks.
+ * @GO_DOTDOT_TEST: check.
+ * @GO_DOTDOT_LEAVE: leave alone.
+ **/
+
 #ifdef G_OS_WIN32
 typedef HRESULT (WINAPI *FindMimeFromData_t) (LPBC pBC,
 					      LPCWSTR pwzUrl,
diff --git a/goffice/utils/go-format.c b/goffice/utils/go-format.c
index 424874e..c34ef1e 100644
--- a/goffice/utils/go-format.c
+++ b/goffice/utils/go-format.c
@@ -51,6 +51,76 @@
 #include <errno.h>
 #include <stdlib.h>
 
+/**
+ * GOFormatFamily:
+ * @GO_FORMAT_UNKNOWN: unknown ,should not occur.
+ * @GO_FORMAT_GENERAL: general.
+ * @GO_FORMAT_NUMBER: number.
+ * @GO_FORMAT_CURRENCY: currency.
+ * @GO_FORMAT_ACCOUNTING: accounting.
+ * @GO_FORMAT_DATE: date.
+ * @GO_FORMAT_TIME: tipe.
+ * @GO_FORMAT_PERCENTAGE: percentage.
+ * @GO_FORMAT_FRACTION: fraction.
+ * @GO_FORMAT_SCIENTIFIC: scientific.
+ * @GO_FORMAT_TEXT: text.
+ * @GO_FORMAT_SPECIAL: custom.
+ **/
+
+/**
+ * GOFormatMagic:
+ * @GO_FORMAT_MAGIC_NONE: none.
+ * @GO_FORMAT_MAGIC_LONG_DATE: long date (Official).
+ * @GO_FORMAT_MAGIC_MEDIUM_DATE: medium date.
+ * @GO_FORMAT_MAGIC_SHORT_DATE: short date.
+ * @GO_FORMAT_MAGIC_SHORT_DATETIME: short date with time.
+ * @GO_FORMAT_MAGIC_LONG_TIME: long time (Official).
+ * @GO_FORMAT_MAGIC_MEDIUM_TIME: medium time.
+ * @GO_FORMAT_MAGIC_SHORT_TIME : short time.
+ **/
+
+/**
+ * GOFormatNumberError:
+ * @GO_FORMAT_NUMBER_OK: no error.
+ * @GO_FORMAT_NUMBER_INVALID_FORMAT: invalid format.
+ * @GO_FORMAT_NUMBER_DATE_ERROR: date error.
+ **/
+
+/**
+ * GOFormatCurrency:
+ * @symbol: currency symbol.
+ * @description: description.
+ * @precedes: whether the symbol precedes the amount.
+ * @has_space: whether to add a space between amount and symbol.
+ **/
+
+/**
+ * GOFormatDetails:
+ * @family: #GOFormatFamily.
+ * @magic: #GOFormatMagic.
+ * @min_digits: minimum digits number.
+ * @num_decimals: decimals number.
+ * @thousands_sep: thousands separator.
+ * @negative_red: display negative number using red ink.
+ * @negative_paren: uses parenthersis around negative numbers.
+ * @currency: #GOFormatCurrency.
+ * @force_quoted: force quotes use.
+ * @exponent_step: steps between allowed exponents in scientific notation.
+ * @exponent_digits: digits number in exponent.
+ * @use_markup: whether to use a markup.
+ * @simplify_mantissa: simplify the mantissa.
+ * @append_SI: append an SI unit.
+ * @appended_SI_unit: the SI unit to append.
+ * @scale: scale.
+ * @automatic_denominator: use an automatic denominator for fractions.
+ * @split_fraction: split the fraction.
+ * @pi_scale: use multiples of pi for fractions, e.g. 1/2*pi.
+ * @numerator_min_digits: minimum digits number for the numerator.
+ * @denominator_min_digits: minimum digits number for the denominator.
+ * @denominator_max_digits: minimum digits number for the denominator.
+ * @denominator: fixed denominator.
+ **/
+
 #define OBSERVE_XL_CONDITION_LIMITS
 #define OBSERVE_XL_EXPONENT_1
 #define ALLOW_NEGATIVE_TIMES
@@ -4580,6 +4650,8 @@ go_format_measure_strlen (const GString *str,
  * @col_width: intended max width of layout in pango units.  -1 means
  *             no restriction.
  * @unicode_minus: Use unicode minuses, not hyphens.
+ * @numeral_shape: numeral shape identifier.
+ * @custom_shape_flags: flags for using @numeral_shape.
  *
  * Render a floating-point value into @layout in such a way that the
  * layouting width does not needlessly exceed @col_width.  Optionally
@@ -4595,6 +4667,8 @@ go_format_measure_strlen (const GString *str,
  * @col_width: intended max width of layout in pango units.  -1 means
  *             no restriction.
  * @unicode_minus: Use unicode minuses, not hyphens.
+ * @numeral_shape: numeral shape identifier.
+ * @custom_shape_flags: flags for using @numeral_shape.
  *
  * Render a floating-point value into @layout in such a way that the
  * layouting width does not needlessly exceed @col_width.  Optionally
diff --git a/goffice/utils/go-format.h b/goffice/utils/go-format.h
index 5c6e5ea..2fcb7b4 100644
--- a/goffice/utils/go-format.h
+++ b/goffice/utils/go-format.h
@@ -48,6 +48,7 @@ typedef enum {
 	GO_FORMAT_TEXT		= 9,
 	GO_FORMAT_SPECIAL	= 10,
 
+	/* <private> */
 	GO_FORMAT_MARKUP	= 11	/* Internal use only */
 } GOFormatFamily;
 
@@ -116,7 +117,8 @@ typedef struct {
 	int denominator_max_digits;
 	int denominator;
 
-	int expansion[30];
+	/* <private> */
+	int expansion[30]; /* what is this for? */
 	unsigned ref_count;
 } GOFormatDetails;
 
diff --git a/goffice/utils/go-geometry.c b/goffice/utils/go-geometry.c
index 7e2561f..5516cb7 100644
--- a/goffice/utils/go-geometry.c
+++ b/goffice/utils/go-geometry.c
@@ -26,6 +26,44 @@
 
 #include <glib/gi18n-lib.h>
 
+/**
+ * GOGeometrySide:
+ * @GO_SIDE_LEFT: left.
+ * @GO_SIDE_RIGHT: right.
+ * @GO_SIDE_LEFT_RIGHT: left or right.
+ * @GO_SIDE_TOP: top.
+ * @GO_SIDE_BOTTOM: bottom.
+ * @GO_SIDE_TOP_BOTTOM: top or bottom.
+ * @GO_SIDE_AUTO: auto.
+ **/
+
+/**
+ * GODirection:
+ * @GO_DIRECTION_UP: up.
+ * @GO_DIRECTION_DOWN: down.
+ * @GO_DIRECTION_LEFT: left.
+ * @GO_DIRECTION_RIGHT: right.
+ * @GO_DIRECTION_NONE: no direction.
+ **/
+
+/**
+ * GOGeometryRotationType:
+ * @GO_ROTATE_NONE: no rotation.
+ * @GO_ROTATE_COUNTERCLOCKWISE: counter clockwise.
+ * @GO_ROTATE_UPSIDEDOWN: upside down.
+ * @GO_ROTATE_CLOCKWISE: clockwise.
+ * @GO_ROTATE_FREE: free rotation.
+ **/
+
+/**
+ * GOGeometryOBR:
+ * @x: vertical position of the center.
+ * @y: vertical position of the center.
+ * @w: width.
+ * @h: height.
+ * @alpha: Aangle from x axis to w edge, in radians.
+ **/
+
 #define dist(x0, y0, x1, y1) hypot((x0) - (x1),(y0) - (y1))
 
 /**
diff --git a/goffice/utils/go-gradient.c b/goffice/utils/go-gradient.c
index 6907e1b..887e53f 100644
--- a/goffice/utils/go-gradient.c
+++ b/goffice/utils/go-gradient.c
@@ -31,6 +31,27 @@
 #include <glib/gi18n-lib.h>
 #include <string.h>
 
+/**
+ * GOGradientDirection:
+ * @GO_GRADIENT_N_TO_S: top to bottom.
+ * @GO_GRADIENT_S_TO_N: bottom to top.
+ * @GO_GRADIENT_N_TO_S_MIRRORED: top to bottom, mirrored.
+ * @GO_GRADIENT_S_TO_N_MIRRORED: bottom to top, mirrored.
+ * @GO_GRADIENT_W_TO_E: left to right.
+ * @GO_GRADIENT_E_TO_W: right to left.
+ * @GO_GRADIENT_W_TO_E_MIRRORED: left to right, mirrored.
+ * @GO_GRADIENT_E_TO_W_MIRRORED: right to left, mirrored.
+ * @GO_GRADIENT_NW_TO_SE: top left to bottom right.
+ * @GO_GRADIENT_SE_TO_NW: bottom right to top left.
+ * @GO_GRADIENT_NW_TO_SE_MIRRORED: top left to bottom right, mirrored.
+ * @GO_GRADIENT_SE_TO_NW_MIRRORED: bottom right to top left, mirrored.
+ * @GO_GRADIENT_NE_TO_SW: top right to bottom left.
+ * @GO_GRADIENT_SW_TO_NE: bottom left to top right.
+ * @GO_GRADIENT_SW_TO_NE_MIRRORED: top right to bottom left, mirrored.
+ * @GO_GRADIENT_NE_TO_SW_MIRRORED: bottom left to top right, mirrored.
+ * @GO_GRADIENT_MAX: maximum value, should not occur.
+} ;
+ **/
 
 static char const *grad_dir_names[] = {
 	"n-s",
diff --git a/goffice/utils/go-image.c b/goffice/utils/go-image.c
index e0285b3..05a4269 100644
--- a/goffice/utils/go-image.c
+++ b/goffice/utils/go-image.c
@@ -27,6 +27,42 @@
 #include <glib/gi18n-lib.h>
 #include <librsvg/rsvg.h>
 
+/**
+ * GOImageFormat:
+ * @GO_IMAGE_FORMAT_SVG: SVG.
+ * @GO_IMAGE_FORMAT_PNG: PNG.
+ * @GO_IMAGE_FORMAT_JPG: JPEG.
+ * @GO_IMAGE_FORMAT_PDF: PDF.
+ * @GO_IMAGE_FORMAT_PS: PostScript.
+ * @GO_IMAGE_FORMAT_EMF: Enhanced Metafile.
+ * @GO_IMAGE_FORMAT_WMF: Windows Metafile.
+ * @GO_IMAGE_FORMAT_EPS: Encapsulated Postscript.
+ * @GO_IMAGE_FORMAT_UNKNOWN: unknown.
+ **/
+
+/**
+ * GOImageFormatInfo:
+ * @format: #GOImageFormat.
+ * @name: image type name.
+ * @desc: image type description.
+ * @ext: file extension.
+ * @has_pixbuf_saver: can be saved as pixbuf.
+ * @is_dpi_useful: depends upon device resolution.
+ * @alpha_support: supports transparency.
+ **/
+
+/**
+ * GOImageClass
+ * @parent_klass: parent class.
+ * @get_pixbuf: gets a pixbuf with the same size as the image.
+ * @get_scaled_pixbuf: gets a scaled pixbuf respecting the original aspect ratio.
+ * @save: saves the image.
+ * @load_attr: loads the images properties.
+ * @load_data: loads the image data.
+ * @draw: draws the image.
+ * @differ: returns %TRUE if the two images are different.
+ **/
+
 static GOImageFormatInfo *pixbuf_image_format_infos = NULL;
 static GHashTable *pixbuf_mimes = NULL;
 static unsigned pixbuf_format_nbr = 0;
diff --git a/goffice/utils/go-image.h b/goffice/utils/go-image.h
index 374a84f..2241173 100644
--- a/goffice/utils/go-image.h
+++ b/goffice/utils/go-image.h
@@ -81,7 +81,6 @@ typedef struct {
 
 	GdkPixbuf *(*get_pixbuf) (GOImage *image);
 	GdkPixbuf *(*get_scaled_pixbuf) (GOImage *image, int width, int height);
-	gboolean (*same_content) (GOImage *img1, GOImage *img2);
 	void (*save) (GOImage *image, GsfXMLOut *output);
 	void (*load_attr) (GOImage *image, xmlChar const *attr_name, xmlChar const *attr_value);
 	void (*load_data) (GOImage *image, GsfXMLIn *xin);
diff --git a/goffice/utils/go-line.c b/goffice/utils/go-line.c
index f211a7f..833e205 100644
--- a/goffice/utils/go-line.c
+++ b/goffice/utils/go-line.c
@@ -26,7 +26,7 @@
 #include <glib/gi18n-lib.h>
 
 /**
- * GOLineDashType
+ * GOLineDashType:
  * @GO_LINE_NONE: No line displayed.
  * @GO_LINE_SOLID: Solid line.
  * @GO_LINE_S_DOT:
@@ -43,7 +43,7 @@
  **/
 
 /**
- * GOLineInterpolation
+ * 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.
@@ -59,6 +59,28 @@
  * @GO_LINE_INTERPOLATION_MAX: First invalid value.
  **/
 
+/**
+ * GOLineDashSequence:
+ * @offset: offset from start.
+ * @n_dash: number of values in dash fields
+ * @dash: lengths of the dashes segments. See cairo_set_dash() for details.
+ **/
+
+/**
+ * GOArrowType:
+ * @GO_ARROW_NONE: no arrow head.
+ * @GO_ARROW_KITE: kite head.
+ * @GO_ARROW_OVAL: oval head.
+ **/
+
+/**
+ * GOArrow:
+ * @typ: #GOArrowType.
+ * @a: first arrow head size parameter.
+ * @b: second arrow head size parameter.
+ * @c: third arrow head size parameter.
+ **/
+
 static GOLineDashSequence *
 go_line_dash_sequence_ref (GOLineDashSequence * sequence)
 {
diff --git a/goffice/utils/go-line.h b/goffice/utils/go-line.h
index 38fd80f..96c1071 100644
--- a/goffice/utils/go-line.h
+++ b/goffice/utils/go-line.h
@@ -30,6 +30,7 @@ typedef struct {
 	double		 offset;
 	unsigned int	 n_dash;
 	double		*dash;
+	/* <private> */
 	unsigned ref_count;
 } GOLineDashSequence;
 GType go_line_dash_sequence_get_type (void);
diff --git a/goffice/utils/go-marker.c b/goffice/utils/go-marker.c
index 863e4dd..8b6ca54 100644
--- a/goffice/utils/go-marker.c
+++ b/goffice/utils/go-marker.c
@@ -25,6 +25,27 @@
 #include <glib/gi18n-lib.h>
 #include <gsf/gsf-impl-utils.h>
 
+/**
+ * GOMarkerShape:
+ * @GO_MARKER_NONE: no mark.
+ * @GO_MARKER_SQUARE: square.
+ * @GO_MARKER_DIAMOND: diamond.
+ * @GO_MARKER_TRIANGLE_DOWN: triangle down.
+ * @GO_MARKER_TRIANGLE_UP: triangle up.
+ * @GO_MARKER_TRIANGLE_RIGHT: triangle right.
+ * @GO_MARKER_TRIANGLE_LEFT: triangle left.
+ * @GO_MARKER_CIRCLE: circle.
+ * @GO_MARKER_X: X.
+ * @GO_MARKER_CROSS: cross.
+ * @GO_MARKER_ASTERISK: asterisk.
+ * @GO_MARKER_BAR: horizontal bar.
+ * @GO_MARKER_HALF_BAR: right half bar.
+ * @GO_MARKER_BUTTERFLY: butterfly.
+ * @GO_MARKER_HOURGLASS: hourglass.
+ * @GO_MARKER_LEFT_HALF_BAR: left half bar.
+ * @GO_MARKER_MAX: maximum value, should not occur.
+ **/
+
 #define MARKER_DEFAULT_SIZE 5
 #define MARKER_OUTLINE_WIDTH 0.1
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]