[goffice] Doc fixes

From: Morten Welinder <mortenw src gnome org>
To: commits-list gnome org
Cc:
Subject: [goffice] Doc fixes
Date: Mon, 16 Apr 2018 23:29:53 +0000 (UTC)
commit 4d9a16658b5e2f0f4f794ccbad3be932e8a17c14
Author: Morten Welinder <terra gnome org>
Date:   Mon Apr 16 19:29:33 2018 -0400

    Doc fixes

 goffice/app/file.c                  |    1 +
 goffice/canvas/goc-styled-item.c    |    2 +
 goffice/graph/gog-data-set.c        |    1 +
 goffice/graph/gog-graph.c           |    2 +
 goffice/graph/gog-label.c           |    1 +
 goffice/graph/gog-object.c          |   12 +++++++++++
 goffice/graph/gog-object.h          |    1 +
 goffice/graph/gog-outlined-object.c |    1 +
 goffice/graph/gog-plot.c            |    2 +
 goffice/graph/gog-reg-curve.c       |    1 +
 goffice/graph/gog-renderer.c        |    6 ++++-
 goffice/graph/gog-series.c          |    2 +
 goffice/graph/gog-styled-object.c   |    2 +
 goffice/utils/go-format.c           |   37 ++++++++++++++++++++++++++++------
 goffice/utils/go-path.c             |   14 +++++++++++++
 goffice/utils/go-styled-object.c    |    1 +
 16 files changed, 78 insertions(+), 8 deletions(-)
---
diff --git a/goffice/app/file.c b/goffice/app/file.c
index f5caffb..cdd02aa 100644
--- a/goffice/app/file.c
+++ b/goffice/app/file.c
@@ -360,6 +360,7 @@ go_file_opener_is_encoding_dependent (GOFileOpener const *fo)
 /**
  * go_file_opener_can_probe:
  * @fo: #GOFileOpener to query
+ * @pl: probe level
  *
  * Returns: %TRUE if @fo has a probe function
  */
diff --git a/goffice/canvas/goc-styled-item.c b/goffice/canvas/goc-styled-item.c
index e1eec99..71be514 100644
--- a/goffice/canvas/goc-styled-item.c
+++ b/goffice/canvas/goc-styled-item.c
@@ -36,6 +36,8 @@
 /**
  * GocStyledItemClass :
  * @init_style: style initialization handler.
+ * @reserved1: reserved for future expansion
+ * @reserved2: reserved for future expansion
  **/
 enum {
        STYLED_ITEM_PROP_0,
diff --git a/goffice/graph/gog-data-set.c b/goffice/graph/gog-data-set.c
index c373015..c0b18fc 100644
--- a/goffice/graph/gog-data-set.c
+++ b/goffice/graph/gog-data-set.c
@@ -31,6 +31,7 @@
 
 /**
  * GogDatasetClass:
+ * @base: base class
  * @get_elem: gets i-th element.
  * @set_dim: sets the data for i-th element.
  * @dims: gest first and last valid elements indices.
diff --git a/goffice/graph/gog-graph.c b/goffice/graph/gog-graph.c
index 3a85527..ae21c46 100644
--- a/goffice/graph/gog-graph.c
+++ b/goffice/graph/gog-graph.c
@@ -61,6 +61,8 @@
 /**
  * GogGraphClass:
  * @base: base class.
+ * @add_data: implements the "add-data" signal.
+ * @remove_data: implements the "remove-data" signal.
  **/
 
 /**
diff --git a/goffice/graph/gog-label.c b/goffice/graph/gog-label.c
index b2e8f56..bfd3cc8 100644
--- a/goffice/graph/gog-label.c
+++ b/goffice/graph/gog-label.c
@@ -36,6 +36,7 @@
 
 /**
  * GogTextClass:
+ * @base: base class
  * @get_str: returns the text associated with the object.
  * @get_markup: returns the pango attributes.
  **/
diff --git a/goffice/graph/gog-object.c b/goffice/graph/gog-object.c
index 3284095..ebb53c8 100644
--- a/goffice/graph/gog-object.c
+++ b/goffice/graph/gog-object.c
@@ -45,6 +45,7 @@
 
 /**
  * GogObjectClass:
+ * @base: base class.
  * @roles: roles for the class.
  * @view_type: view type.
  * @update: updates the object.
@@ -53,6 +54,14 @@
  * @populate_editor: populates the editor.
  * @document_changed: the document changed.
  * @get_manual_size_mode: resize mode.
+ * @changed: implements the "changed" signal.
+ * @name_changed: implements the "name-changed" signal.
+ * @possible_additions_changed: implements the "possible-additions-changed" signal.
+ * @child_added: implements the "child-added" signal.
+ * @child_removed: implements the "child-removed" signal.
+ * @child_name_changed: implements the "child-name-changed" signal.
+ * @children_reordered: implements the "children-reordered" signal.
+ * @update_editor: implements the "update-editor" signal.
  **/
 
 /**
@@ -91,6 +100,9 @@
  * @GOG_POSITION_MANUAL_H: relative height.
  * @GOG_POSITION_MANUAL_H_ABS: absolute height.
  * @GOG_POSITION_ANY_MANUAL_SIZE: mask for manual sizes.
+ * @GOG_POSITION_HEXPAND: expands in the horizontal direction.
+ * @GOG_POSITION_VEXPAND: expands in the vertical direction.
+ * @GOG_POSITION_EXPAND: expands in either direction.
  **/
 
 /**
diff --git a/goffice/graph/gog-object.h b/goffice/graph/gog-object.h
index ed5095f..ce9be45 100644
--- a/goffice/graph/gog-object.h
+++ b/goffice/graph/gog-object.h
@@ -120,6 +120,7 @@ typedef struct {
        void (*child_name_changed) (GogObject const *obj, GogObject const *child);
        void (*children_reordered) (GogObject *obj);
        void (*update_editor)      (GogObject *obj);
+        /*< private >*/
        void (*extra_signal1)      (GogObject *view);
        void (*extra_signal2)      (GogObject *view);
 } GogObjectClass;
diff --git a/goffice/graph/gog-outlined-object.c b/goffice/graph/gog-outlined-object.c
index fa45fe2..bd795e3 100644
--- a/goffice/graph/gog-outlined-object.c
+++ b/goffice/graph/gog-outlined-object.c
@@ -98,6 +98,7 @@ gog_outlined_object_get_pad (GogOutlinedObject const *goo)
 
 /**
  * GogOutlinedViewClass:
+ * @base: base class
  * @call_parent_render: whether the parent class render() method must be
  * called when done.
  **/
diff --git a/goffice/graph/gog-plot.c b/goffice/graph/gog-plot.c
index e29f3e4..5d485ba 100644
--- a/goffice/graph/gog-plot.c
+++ b/goffice/graph/gog-plot.c
@@ -62,6 +62,7 @@
 
 /**
  * GogPlotClass:
+ * @base: base class
  * @desc: #GogPlotDesc
  * @series_type: series type.
  * @axis_set: set of use axes.
@@ -78,6 +79,7 @@
 
 /**
  * GogPlotViewClass:
+ * @base: base class
  * @get_data_at_point: returns the data index at the given position, -1 if none.
  **/
 
diff --git a/goffice/graph/gog-reg-curve.c b/goffice/graph/gog-reg-curve.c
index c667e87..ebf14c6 100644
--- a/goffice/graph/gog-reg-curve.c
+++ b/goffice/graph/gog-reg-curve.c
@@ -34,6 +34,7 @@
 
 /**
  * GogRegCurveClass:
+ * @base: base class
  * @get_value_at: returns the calculated value.
  * @get_equation: gets the regresion equation as a string.
  * @populate_editor: populates the editor.
diff --git a/goffice/graph/gog-renderer.c b/goffice/graph/gog-renderer.c
index 5627181..fecc03e 100644
--- a/goffice/graph/gog-renderer.c
+++ b/goffice/graph/gog-renderer.c
@@ -997,6 +997,7 @@ gog_renderer_draw_text (GogRenderer *rend, char const *text,
  * @rend: #GogRenderer
  * @str: the string to draw
  * @obr: #GOGeometryOBR to store the Object Bounding Rectangle of @text.
+ * @max_width: maximum width or -1 for unrestricted
  **/
 void
 gog_renderer_get_gostring_OBR (GogRenderer *rend, GOString *str,
@@ -1059,6 +1060,7 @@ gog_renderer_get_gostring_OBR (GogRenderer *rend, GOString *str,
  * @text: the string to draw
  * @use_markup: wether to use pango markup
  * @obr: #GOGeometryOBR to store the Object Bounding Rectangle of @text.
+ * @max_width: maximum width or -1 for unrestricted
  **/
 void
 gog_renderer_get_text_OBR (GogRenderer *rend, char const *text,
@@ -1089,6 +1091,7 @@ gog_renderer_get_text_OBR (GogRenderer *rend, char const *text,
  * @text: the string to draw
  * @use_markup: whether to use pango markup
  * @aabr: #GOGeometryAABR to store the Axis Aligned Bounding Rectangle of @text.
+ * @max_width: maximum width or -1 for unrestricted
  **/
 void
 gog_renderer_get_text_AABR (GogRenderer *rend, char const *text,
@@ -1106,10 +1109,11 @@ gog_renderer_get_text_AABR (GogRenderer *rend, char const *text,
  * @rend: #GogRenderer
  * @str: the string to draw
  * @aabr: #GOGeometryAABR to store the Axis Aligned Bounding Rectangle of @text.
+ * @max_width: maximum width or -1 for unrestricted
  **/
 void
 gog_renderer_get_gostring_AABR (GogRenderer *rend, GOString *str,
-                           GOGeometryAABR *aabr, double max_width)
+                               GOGeometryAABR *aabr, double max_width)
 {
        GOGeometryOBR obr;
 
diff --git a/goffice/graph/gog-series.c b/goffice/graph/gog-series.c
index 61977af..7eb7753 100644
--- a/goffice/graph/gog-series.c
+++ b/goffice/graph/gog-series.c
@@ -56,6 +56,7 @@
 
 /**
  * GogSeriesClass:
+ * @base: base class
  * @has_interpolation: supports interpolation.
  * @has_fill_type: %TRUE if filling is supported.
  * @valid_fill_type_list: list of supported #GogSeriesFillType values.
@@ -68,6 +69,7 @@
 
 /**
  * GogSeriesElementClass:
+ * @base: base class
  * @gse_populate_editor: populates editor.
  **/
 
diff --git a/goffice/graph/gog-styled-object.c b/goffice/graph/gog-styled-object.c
index bea1e19..2582c9c 100644
--- a/goffice/graph/gog-styled-object.c
+++ b/goffice/graph/gog-styled-object.c
@@ -52,7 +52,9 @@ GSF_CLASS (GogStyle, gog_style,
 
 /**
  * GogStyledObjectClass:
+ * @base: base class
  * @init_style: intiializes the style.
+ * @style_changed: implemens the style-changed signal
  **/
 
 static void gog_styled_object_style_changed (GOStyledObject *obj);
diff --git a/goffice/utils/go-format.c b/goffice/utils/go-format.c
index b41473d..b71b6b9 100644
--- a/goffice/utils/go-format.c
+++ b/goffice/utils/go-format.c
@@ -4887,13 +4887,13 @@ SUFFIX(ilog10) (DOUBLE x)
 
 /**
  * go_render_general:
- * @layout: Optional PangoLayout, probably preseeded with font attribute.
+ * @layout: Optional #PangoLayout, probably preseeded with font attribute.
  * @str: a GString to store (not append!) the resulting string in.
  * @measure: (scope call): Function to measure width of string/layout.
  * @metrics: Font metrics corresponding to @mesaure.
  * @val: floating-point value.  Must be finite.
- * @col_width: intended max width of layout in pango units.  -1 means
- *             no restriction.
+ * @col_width: intended max width of layout in the units that @measure uses.
+ * A width of -1 means no restriction.
  * @unicode_minus: Use unicode minuses, not hyphens.
  * @numeral_shape: numeral shape identifier.
  * @custom_shape_flags: flags for using @numeral_shape.
@@ -4904,13 +4904,13 @@ SUFFIX(ilog10) (DOUBLE x)
  **/
 /**
  * go_render_generall:
- * @layout: Optional PangoLayout, probably preseeded with font attribute.
+ * @layout: Optional #PangoLayout, probably preseeded with font attribute.
  * @str: a GString to store (not append!) the resulting string in.
  * @measure: (scope call): Function to measure width of string/layout.
  * @metrics: Font metrics corresponding to @mesaure.
  * @val: floating-point value.  Must be finite.
- * @col_width: intended max width of layout in pango units.  -1 means
- *             no restriction.
+ * @col_width: intended max width of layout in the units that @measure uses.
+ * A width of -1 means no restriction.
  * @unicode_minus: Use unicode minuses, not hyphens.
  * @numeral_shape: numeral shape identifier.
  * @custom_shape_flags: flags for using @numeral_shape.
@@ -6670,6 +6670,29 @@ go_format_new_magic (GOFormatMagic m)
 #endif
 
 
+/**
+ * go_format_specialize:
+ * @fmt: the format to specialize
+ * @val: the value to use
+ * @type: the type of value; 'F' for numeric, 'B' for boolean, 'S' for string.
+ * @inhibit_minus: (out): set to %TRUE if the format dictates that a minus
+ * should be inhibited when rendering negative values.
+ *
+ * Returns: (transfer none): @fmt format, presumably a conditional format,
+ * specialized to @value of @type.
+ */
+
+/**
+ * go_format_specializel:
+ * @fmt: the format to specialize
+ * @val: the value to use
+ * @type: the type of value; 'F' for numeric, 'B' for boolean, 'S' for string.
+ * @inhibit_minus: (out): set to %TRUE if the format dictates that a minus
+ * should be inhibited when rendering negative values.
+ *
+ * Returns: (transfer none): @fmt format, presumably a conditional format,
+ * specialized to @value of @type.
+ */
 const GOFormat *
 SUFFIX(go_format_specialize) (GOFormat const *fmt, DOUBLE val, char type,
                              gboolean *inhibit_minus)
@@ -9096,7 +9119,7 @@ go_format_output_conditional_to_odf (GsfXMLOut *xout, gboolean with_extension,
 
        if (defi == -1 && last_implicit_num != -1) {
                /*
-                * The default could be this one, but unless we cannot reorder
+                * The default could be this one, but we cannot reorder
                 * conditions unless we can prove it doesn't matter.  Just
                 * check if it is last.
                 */
diff --git a/goffice/utils/go-path.c b/goffice/utils/go-path.c
index 4ba0e39..56da62d 100644
--- a/goffice/utils/go-path.c
+++ b/goffice/utils/go-path.c
@@ -68,6 +68,20 @@
  * @GO_ANCHOR_SE: anchor bottom left.
  * @GO_ANCHOR_W: anchor left.
  * @GO_ANCHOR_E: anchor right.
+ * @GO_ANCHOR_BASELINE_CENTER: anchor centered on baseline
+ * @GO_ANCHOR_BASELINE_WEST: anchor left on baseline
+ * @GO_ANCHOR_BASELINE_EAST: anchor right on baseline
+ * @GO_ANCHOR_N: synonym for GO_ANCHOR_NORTH
+ * @GO_ANCHOR_NW: synonym for GO_ANCHOR_NORTH_WEST
+ * @GO_ANCHOR_NE: synonym for GO_ANCHOR_NORTH_EAST
+ * @GO_ANCHOR_S: synonym for GO_ANCHOR_SOUTH
+ * @GO_ANCHOR_SW: synonym for GO_ANCHOR_SOUTH_WEST
+ * @GO_ANCHOR_SE: synonym for GO_ANCHOR_SOUTH_EAST
+ * @GO_ANCHOR_W: synonym for GO_ANCHOR_WEST
+ * @GO_ANCHOR_E: synonym for GO_ANCHOR_EAST
+ * @GO_ANCHOR_B: synonym for GO_ANCHOR_BASELINE_CENTER
+ * @GO_ANCHOR_BW: synonym for GO_ANCHOR_BASELINE_WEST
+ * @GO_ANCHOR_BE: synonym for GO_ANCHOR_BASELINE_EAST
  **/
 
 /**
diff --git a/goffice/utils/go-styled-object.c b/goffice/utils/go-styled-object.c
index da567c5..f3ace6d 100644
--- a/goffice/utils/go-styled-object.c
+++ b/goffice/utils/go-styled-object.c
@@ -32,6 +32,7 @@
 
 /**
  * GOStyledObjectClass :
+ * @base: base class
  * @set_style: sets the object style.
  * @get_style: returns the object current style.
  * @get_auto_style: returns the default style for the object.
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]