[goffice] Make Introspection and GtkDoc happy.



commit 599a95b5b506517b6cc8be760769c055c3932c03
Author: Jean Brefort <jean brefort normalesup org>
Date:   Mon Jun 2 11:26:08 2014 +0200

    Make Introspection and GtkDoc happy.

 NEWS                                     |    3 -
 docs/reference/goffice-0.10-sections.txt |   87 ++++++++++++++++++++++++++++++
 goffice/app/go-plugin-service.c          |    6 +-
 goffice/canvas/goc-item.c                |    2 +-
 goffice/canvas/goc-item.h                |    1 +
 goffice/graph/gog-axis.c                 |   19 +++++++
 goffice/graph/gog-styled-object.c        |    5 +-
 goffice/graph/gog-theme.c                |    4 +-
 goffice/utils/go-unit.c                  |   36 ++++++++++++
 goffice/utils/go-unit.h                  |    2 +
 10 files changed, 154 insertions(+), 11 deletions(-)
---
diff --git a/NEWS b/NEWS
index a8ecbb9..df58d14 100644
--- a/NEWS
+++ b/NEWS
@@ -1,12 +1,9 @@
 goffice 0.10.17:
 
-<<<<<<< Updated upstream
 Jean:
        * Add control for 3D plots axes lengths. [#694746]
-=======
 Morten:
        * Fix test for buggy C library.
->>>>>>> Stashed changes
 
 --------------------------------------------------------------------------
 goffice 0.10.16:
diff --git a/docs/reference/goffice-0.10-sections.txt b/docs/reference/goffice-0.10-sections.txt
index 9b12ec4..7a82891 100644
--- a/docs/reference/goffice-0.10-sections.txt
+++ b/docs/reference/goffice-0.10-sections.txt
@@ -453,6 +453,7 @@ go_combo_color_set_allow_alpha
 go_combo_color_set_color
 go_combo_color_set_color_gdk
 go_combo_color_set_color_to_default
+go_combo_color_set_icon
 go_combo_color_set_instant_apply
 <SUBSECTION Standard>
 GO_COMBO_COLOR
@@ -468,6 +469,7 @@ go_combo_color_get_type
 GOComboPixmaps
 GOMenuPixmaps
 go_combo_pixmaps_add_element
+go_combo_pixmaps_clear_elements
 go_combo_pixmaps_get_preview
 go_combo_pixmaps_get_selected
 go_combo_pixmaps_new
@@ -670,6 +672,20 @@ go_csplinel_get_type
 </SECTION>
 
 <SECTION>
+<FILE>go-unit</FILE>
+<TITLE>GoUnit</TITLE>
+GoUnit
+GoUnitId
+go_unit_convert
+go_unit_define
+go_unit_get
+go_unit_get_from_symbol
+go_unit_get_id
+go_unit_get_symbol
+go_unit_get_type
+</SECTION>
+
+<SECTION>
 <FILE>go-data</FILE>
 <TITLE>GOData</TITLE>
 GOData
@@ -1008,6 +1024,7 @@ go_font_metrics_get_type
 <TITLE>GOFontSel</TITLE>
 GOFontSel
 go_font_sel_editable_enters
+go_font_sel_get_color
 go_font_sel_get_font
 go_font_sel_new
 go_font_sel_set_font
@@ -1101,6 +1118,9 @@ go_format_new_magic
 go_format_new_markup
 go_format_odf_style_map
 go_format_output_to_odf
+go_format_palette_color_of_index
+go_format_palette_index_from_color
+go_format_palette_name_of_index
 go_format_ref
 go_format_specialize
 go_format_specializel
@@ -1518,6 +1538,11 @@ go_strtod
 go_strtold
 go_sub_epsilon
 go_sub_epsilonl
+go_atan2pi
+go_atan2pil
+go_cospi
+go_cospil
+go_dtoa
 isnan
 ldexpl
 log1p
@@ -1882,6 +1907,40 @@ go_quad_sub
 go_quad_subl
 go_quad_value
 go_quad_valuel
+go_quad_acos
+go_quad_acosl
+go_quad_asin
+go_quad_asinl
+go_quad_atan2
+go_quad_atan2l
+go_quad_atan2pi
+go_quad_atan2pil
+go_quad_constant8
+go_quad_constant8l
+go_quad_cos
+go_quad_cosl
+go_quad_cospi
+go_quad_cospil
+go_quad_exp
+go_quad_expl
+go_quad_expm1
+go_quad_expm1l
+go_quad_floor
+go_quad_floorl
+go_quad_hypot
+go_quad_hypotl
+go_quad_log
+go_quad_logl
+go_quad_pow
+go_quad_powl
+go_quad_sin
+go_quad_sinl
+go_quad_sinpi
+go_quad_sinpil
+go_sinpi
+go_sinpil
+go_tanpi
+go_tanpil
 <SUBSECTION Private>
 GOQuad
 GOQuadl
@@ -2719,6 +2778,25 @@ go_pango_measure_string
 </SECTION>
 
 <SECTION>
+<FILE>go-math-editor</FILE>
+<TITLE>GoMathEditor</TITLE>
+GO_TYPE_MATH_EDITOR
+GoMathEditor
+go_math_editor_get_inline
+go_math_editor_get_itex
+go_math_editor_get_mathml
+go_math_editor_get_type
+go_math_editor_new
+go_math_editor_set_inline
+go_math_editor_set_itex
+go_math_editor_set_mathml
+go_mathml_to_itex
+<SUBSECTION Standard>
+GO_IS_MATH_EDITOR
+GO_MATH_EDITOR
+</SECTION>
+
+<SECTION>
 <FILE>goffice-math</FILE>
 
 </SECTION>
@@ -2728,10 +2806,15 @@ go_pango_measure_string
 <TITLE>Gog3DBox</TITLE>
 GOG_3D_BOX_TYPE
 Gog3DBox
+Gog3DBoxView
 <SUBSECTION Standard>
 GOG_3D_BOX
 GOG_IS_3D_BOX
 gog_3d_box_get_type
+GOG_3D_BOX_VIEW
+GOG_3D_BOX_VIEW_TYPE
+GOG_IS_3D_BOX_VIEW
+gog_3d_box_view_get_type
 </SECTION>
 
 <SECTION>
@@ -2741,6 +2824,7 @@ GogAxisElemType
 GogAxisPolarUnit
 GogAxisTick
 GogAxisSet
+GogAxisMetrics
 GogAxisType
 gog_axis_add_contributor
 gog_axis_bound_changed
@@ -2759,8 +2843,11 @@ gog_axis_get_entry
 gog_axis_get_format
 gog_axis_get_grid_line
 gog_axis_get_labels
+gog_axis_get_major_ticks_distance
+gog_axis_get_metrics
 gog_axis_get_polar_perimeter
 gog_axis_get_polar_unit
+gog_axis_get_ref_axis
 gog_axis_get_ticks
 gog_axis_is_center_on_ticks
 gog_axis_is_discrete
diff --git a/goffice/app/go-plugin-service.c b/goffice/app/go-plugin-service.c
index 494dee6..06bba44 100644
--- a/goffice/app/go-plugin-service.c
+++ b/goffice/app/go-plugin-service.c
@@ -577,7 +577,7 @@ GSF_CLASS (GOPluginServiceFileOpener, go_plugin_service_file_opener,
            GO_TYPE_PLUGIN_SERVICE)
 
 
-/** GOPluginFileOpener class **/
+/*** GOPluginFileOpener class ***/
 
 #define TYPE_GO_PLUGIN_FILE_OPENER             (go_plugin_file_opener_get_type ())
 #define GO_PLUGIN_FILE_OPENER(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), 
TYPE_GO_PLUGIN_FILE_OPENER, GOPluginFileOpener))
@@ -729,7 +729,7 @@ go_plugin_file_opener_new (GOPluginService *service)
        return fo;
 }
 
-/** -- **/
+/*** -- ***/
 
 
 /*
@@ -898,7 +898,7 @@ GSF_CLASS (GOPluginServiceFileSaver, go_plugin_service_file_saver,
            GO_TYPE_PLUGIN_SERVICE)
 
 
-/** GOPluginFileSaver class **/
+/*** GOPluginFileSaver class ***/
 
 #define TYPE_GO_PLUGIN_FILE_SAVER             (go_plugin_file_saver_get_type ())
 #define GO_PLUGIN_FILE_SAVER(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), TYPE_GO_PLUGIN_FILE_SAVER, 
GOPluginFileSaver))
diff --git a/goffice/canvas/goc-item.c b/goffice/canvas/goc-item.c
index 90eb2c1..e04c240 100644
--- a/goffice/canvas/goc-item.c
+++ b/goffice/canvas/goc-item.c
@@ -115,7 +115,7 @@ enum {
  * @notify_scrolled: callback for a notify scrolled event. This is useful to
  * reposition children of the GtkLayout parent of the canvas to their new
  * position.
- * @get_window: returns the#GdkWindow for the item if any.
+ * @get_window: returns the #GdkWindow for the item if any.
  *
  * The base class for all canvas items.
  **/
diff --git a/goffice/canvas/goc-item.h b/goffice/canvas/goc-item.h
index 5dfb00c..6d7d948 100644
--- a/goffice/canvas/goc-item.h
+++ b/goffice/canvas/goc-item.h
@@ -70,6 +70,7 @@ struct _GocItemClass {
        gboolean                (*key_released) (GocItem *item, GdkEventKey* ev);
        GdkWindow*              (*get_window) (GocItem *item);
 #endif
+
        /* <private> */
        void (*reserved1) (void);
        void (*reserved2) (void);
diff --git a/goffice/graph/gog-axis.c b/goffice/graph/gog-axis.c
index 2cf2c7e..d51c62f 100644
--- a/goffice/graph/gog-axis.c
+++ b/goffice/graph/gog-axis.c
@@ -72,6 +72,17 @@
  * The indices of the #GOData associated to the axis.
  **/
 
+/**
+ * GogAxisMetrics:
+ * @GOG_AXIS_METRICS_INVALID: invalid.
+ * @GOG_AXIS_METRICS_DEFAULT: default.
+ * @GOG_AXIS_METRICS_ABSOLUTE: absolute distance between major ticks.
+ * @GOG_AXIS_METRICS_RELATIVE: relative to another axis.
+ * @GOG_AXIS_METRICS_RELATIVE_TICKS: relative distance between ticks related to
+ * another axis.
+ * @GOG_AXIS_METRICS_MAX: first unused value.
+ **/
+
 
 static struct {
        GogAxisPolarUnit unit;
@@ -3979,6 +3990,14 @@ gog_axis_get_metrics (GogAxis const *axis)
        return axis->metrics;
 }
 
+/**
+ * gog_axis_get_ref_axis:
+ * @axis: a #GogAxis
+ *
+ * Since: 0.10.17
+ * Returns: (transfer none): the axis used to evaluate the length of @axis or
+ * NULL.
+ **/
 GogAxis *
 gog_axis_get_ref_axis (GogAxis const *axis)
 {
diff --git a/goffice/graph/gog-styled-object.c b/goffice/graph/gog-styled-object.c
index 6f75d47..bea1e19 100644
--- a/goffice/graph/gog-styled-object.c
+++ b/goffice/graph/gog-styled-object.c
@@ -36,10 +36,11 @@ enum {
        LAST_SIGNAL
 };
 
-/**GogStyle:
+/*
+ * GogStyle:
  * This is a mere copy of GOStyle but is needed for file
  * format compatibility
- **/
+ */
 struct _GogStyle {
        GOStyle base;
 };
diff --git a/goffice/graph/gog-theme.c b/goffice/graph/gog-theme.c
index 66b6d42..393eb28 100644
--- a/goffice/graph/gog-theme.c
+++ b/goffice/graph/gog-theme.c
@@ -58,8 +58,8 @@
  * GOStyle nodes:
  *
  * These nodes actually define the theme. Attributes and contents are:
- * attributes: class, role.
- * contents: (line|outline)?, fill?, marker?, font?, text_layout?
+ * node attributes: class, role.
+ * node contents: (line|outline)?, fill?, marker?, font?, text_layout?
  *
  * The attributes define the target for the style. You might have a class and
  * a role attribute, or just one of them. If the role attribute is given, the class attribute,
diff --git a/goffice/utils/go-unit.c b/goffice/utils/go-unit.c
index 556797c..fe24aa2 100644
--- a/goffice/utils/go-unit.c
+++ b/goffice/utils/go-unit.c
@@ -22,6 +22,16 @@
 #include <goffice/utils/go-unit.h>
 #include <string.h>
 
+/**
+ * GoUnitId:
+ * @GO_UNIT_UNKNOWN: unknown unit.
+ * @GO_UNIT_METER: meter.
+ * @GO_UNIT_CENTIMETER: centimeter.
+ * @GO_UNIT_INCH: inch.
+ * @GO_UNIT_POINT: point.
+ * @GO_UNIT_MAX: first unregistered unit.
+ **/
+
 static GHashTable *units_hash = NULL;
 static GPtrArray *custom_units;
 
@@ -32,6 +42,32 @@ struct _GoUnit {
        unsigned Id;
 };
 
+/* let's have a boxed type to make introspection happy */
+static GoUnit const *
+go_unit_copy (GoUnit const *unit)
+{
+       return unit;
+}
+
+static void
+go_unit_free (GoUnit *unit)
+{
+       /* nothing to do */
+}
+
+GType
+go_unit_get_type (void)
+{
+       static GType t = 0;
+
+       if (t == 0) {
+               t = g_boxed_type_register_static ("GoUnit",
+                        (GBoxedCopyFunc)go_unit_copy,
+                        (GBoxedFreeFunc)go_unit_free);
+       }
+       return t;
+}
+
 static int last_unit = GO_UNIT_MAX;
 
 GoUnit units[GO_UNIT_MAX] = {
diff --git a/goffice/utils/go-unit.h b/goffice/utils/go-unit.h
index 5253528..54c9e47 100644
--- a/goffice/utils/go-unit.h
+++ b/goffice/utils/go-unit.h
@@ -37,6 +37,8 @@ typedef enum  {
        GO_UNIT_MAX
 } GoUnitId;
 
+GType go_unit_get_type (void);
+
 char const *go_unit_get_symbol (GoUnit const *unit);
 GoUnitId go_unit_get_id (GoUnit const *unit);
 double go_unit_convert (GoUnit const *from, GoUnit const *to, double value);


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]