[goffice] Introspection and doc fixes.

From: Morten Welinder <mortenw src gnome org>
To: commits-list gnome org
Cc:
Subject: [goffice] Introspection and doc fixes.
Date: Tue, 22 Feb 2022 00:22:56 +0000 (UTC)
commit 348c33a3ddfd0e50de3d959bf73664953f5abd61
Author: Morten Welinder <terra gnome org>
Date:   Mon Feb 21 19:22:41 2022 -0500

    Introspection and doc fixes.

 NEWS                                     |   1 +
 docs/reference/goffice-0.10-sections.txt |  31 +++++++
 goffice/canvas/goc-item.c                |   4 +-
 goffice/graph/gog-object.c               |   3 +
 goffice/graph/gog-plot.c                 |   1 +
 goffice/graph/gog-series.c               |   2 +
 goffice/graph/gog-theme.c                |   2 +-
 goffice/graph/gog-view.c                 |   5 +-
 goffice/math/go-matrix.c                 | 114 +++++++++++++++++++++++--
 goffice/math/go-rangefunc.c              | 139 +++++++++++++++++++++++++++++--
 goffice/utils/go-line.c                  |  22 ++---
 11 files changed, 292 insertions(+), 32 deletions(-)
---
diff --git a/NEWS b/NEWS
index 0ca1e883..2d0cf932 100644
--- a/NEWS
+++ b/NEWS
@@ -4,6 +4,7 @@ Morten:
        * Improve GOComboBox css styling.
        * Reimplement GOActionComboStack using GtkComboBox.
        * Introspection fixes.
+       * Documentation fixes.
        * Fix go_{add,sub}_epsilon{,l} confusion in fallback code for win32.
 
 --------------------------------------------------------------------------
diff --git a/docs/reference/goffice-0.10-sections.txt b/docs/reference/goffice-0.10-sections.txt
index e2566ec0..33b27636 100644
--- a/docs/reference/goffice-0.10-sections.txt
+++ b/docs/reference/goffice-0.10-sections.txt
@@ -397,6 +397,7 @@ GOColorPalette
 go_color_palette_get_current_color
 go_color_palette_make_menu
 go_color_palette_new
+go_color_palette_query
 go_color_palette_set_allow_alpha
 go_color_palette_set_color_to_default
 go_color_palette_set_current_color
@@ -488,6 +489,8 @@ go_menu_pixmaps_get_type
 <SECTION>
 <FILE>go-complex</FILE>
 <TITLE>GOComplex</TITLE>
+go_complex_get_type
+go_complexl_get_type
 go_complex_add
 go_complex_addl
 go_complex_angle
@@ -504,6 +507,8 @@ go_complex_exp
 go_complex_expl
 go_complex_from_polar
 go_complex_from_polarl
+go_complex_from_polar_pi
+go_complex_from_polar_pil
 go_complex_from_string
 go_complex_from_stringl
 go_complex_init
@@ -520,6 +525,8 @@ go_complex_mul
 go_complex_mull
 go_complex_pow
 go_complex_powl
+go_complex_powx
+go_complex_powxl
 go_complex_real
 go_complex_real_p
 go_complex_real_pl
@@ -867,11 +874,15 @@ go_distribution_get_type
 <TITLE>GODoc</TITLE>
 GODoc
 go_doc_add_image
+go_doc_bump_state
 go_doc_end_read
 go_doc_get_dirty_time
 go_doc_get_image
 go_doc_get_images
 go_doc_get_meta_data
+go_doc_get_modtime
+go_doc_get_saved_state
+go_doc_get_state
 go_doc_get_uri
 go_doc_image_fetch
 go_doc_init_read
@@ -884,7 +895,10 @@ go_doc_save_resource
 go_doc_set_dirty
 go_doc_set_dirty_time
 go_doc_set_meta_data
+go_doc_set_modtime
 go_doc_set_pristine
+go_doc_set_saved_state
+go_doc_set_state
 go_doc_set_uri
 go_doc_update_meta_data
 go_doc_write
@@ -972,6 +986,7 @@ go_file_get_date_accessed
 go_file_get_date_changed
 go_file_get_date_modified
 go_file_get_group_name
+go_file_get_modtime
 go_file_get_owner_name
 go_file_open
 go_file_split_urls
@@ -1101,8 +1116,11 @@ go_format_get_details
 go_format_get_family
 go_format_get_magic
 go_format_get_markup
+go_format_has_day
 go_format_has_hour
 go_format_has_minute
+go_format_has_month
+go_format_has_year
 go_format_inc_precision
 go_format_is_date
 go_format_is_general
@@ -1227,6 +1245,8 @@ go_mem_chunk_destroy
 go_mem_chunk_foreach_leak
 go_mem_chunk_free
 go_mem_chunk_new
+go_memdup
+go_memdup_n
 go_object_properties_apply
 go_object_properties_collect
 go_object_properties_free
@@ -1559,6 +1579,9 @@ go_fake_trunc
 go_fake_truncl
 go_finite
 go_finitel
+go_log10l
+go_pow
+go_powl
 go_pow10
 go_pow10l
 go_pow2
@@ -1594,6 +1617,7 @@ GOOptionMenu
 go_option_menu_get_history
 go_option_menu_new
 go_option_menu_build
+go_option_menu_get_label
 go_option_menu_select_item
 go_option_menu_set_history
 go_option_menu_set_menu
@@ -2496,6 +2520,10 @@ goc_group_adjust_bounds
 goc_group_adjust_coords
 goc_group_cairo_transform
 goc_group_clear
+goc_group_find_child
+goc_group_freeze
+goc_group_get_child
+goc_group_get_children
 goc_group_new
 goc_group_remove_child
 goc_group_set_clip_path
@@ -2512,10 +2540,12 @@ goc_group_get_type
 GocItem
 GocItemClass
 goc_item_bounds_changed
+goc_item_copy
 goc_item_destroy
 goc_item_distance
 goc_item_draw
 goc_item_draw_region
+goc_item_duplicate
 goc_item_get_bounds
 goc_item_get_operator
 goc_item_get_parent
@@ -2808,6 +2838,7 @@ go_gtk_window_set_transient
 go_gui_get_image_save_info
 go_menu_position_below
 go_pango_measure_string
+go_style_context_from_selector
 </SECTION>
 
 <SECTION>
diff --git a/goffice/canvas/goc-item.c b/goffice/canvas/goc-item.c
index 936e42d5..e526ac26 100644
--- a/goffice/canvas/goc-item.c
+++ b/goffice/canvas/goc-item.c
@@ -940,8 +940,8 @@ goc_item_duplicate (GocItem *item, GocGroup *parent)
 
 /**
  * goc_item_copy:
- * source: #GocItem
- * dest: #GocItem
+ * @source: #GocItem
+ * @dest: #GocItem
  *
  * Copies @source properties to @dest. The two items must be of the same type
  * and their common class needs a @copy member.
diff --git a/goffice/graph/gog-object.c b/goffice/graph/gog-object.c
index 8a820467..ec9f4699 100644
--- a/goffice/graph/gog-object.c
+++ b/goffice/graph/gog-object.c
@@ -48,6 +48,8 @@
  * @base: base class.
  * @roles: roles for the class.
  * @view_type: view type.
+ * @use_parent_as_proxy: internal.
+ * @roles_allocated: internal.
  * @update: updates the object.
  * @parent_changed: called when parent changed.
  * @type_name: gets the type public name.
@@ -109,6 +111,7 @@
  * GogObjectRole:
  * @id: id for persistence.
  * @is_a_typename: type name.
+ * @priority: priority.
  * @allowable_positions: allowed positions inside parent.
  * @default_position: default position.
  * @naming_conv: naming convention.
diff --git a/goffice/graph/gog-plot.c b/goffice/graph/gog-plot.c
index 219441a0..6e6a8d27 100644
--- a/goffice/graph/gog-plot.c
+++ b/goffice/graph/gog-plot.c
@@ -98,6 +98,7 @@
 /**
  * GogPlotDesc:
  * @series: series description.
+ * @num_series_max: maximum number of series that can be added.
  **/
 
 /**
diff --git a/goffice/graph/gog-series.c b/goffice/graph/gog-series.c
index 959563b3..f2a1fec6 100644
--- a/goffice/graph/gog-series.c
+++ b/goffice/graph/gog-series.c
@@ -86,6 +86,8 @@
 /**
  * GogSeriesDesc:
  * @dim: dimensions descriptions.
+ * @style_fields: the style fields that are meaningful for series.
+ * @num_dim: number of dimensions for series.
  **/
 
 /**
diff --git a/goffice/graph/gog-theme.c b/goffice/graph/gog-theme.c
index 27ef10e2..b6341f84 100644
--- a/goffice/graph/gog-theme.c
+++ b/goffice/graph/gog-theme.c
@@ -985,7 +985,7 @@ gog_theme_get_name (GogTheme const *theme)
  * gog_theme_get_descrition:
  * @theme: a #GogTheme
  *
- * Returns: the localized GogTheme decription.
+ * Returns: the localized GogTheme description.
  **/
 
 char const *
diff --git a/goffice/graph/gog-view.c b/goffice/graph/gog-view.c
index a5886ab2..f6ca8c4f 100644
--- a/goffice/graph/gog-view.c
+++ b/goffice/graph/gog-view.c
@@ -29,6 +29,7 @@
 /**
  * GogViewClass:
  * @base: base class.
+ * @clip: If %TRUE,  clip drawings to the view allocation.
  * @state_init: state intialization.
  * @padding_request: padding request.
  * @size_request: size request.
@@ -37,9 +38,6 @@
  * @build_toolkit: builds the associated toolkit.
  * @get_tip_at_point: gets tip at pointer position.
  * @natural_size: gets natural size.
- *
- * the GogViewClass::clip firled should be set to %TRUE to clip drawings to
- * the vew allocation.
  **/
 
 /**
@@ -264,6 +262,7 @@ static GogTool gog_tool_resize_object = {
  * @view: #GogView
  * @tool: #GogTool
  * @data: user data.
+ * @ref_count: internal.
  **/
 
 static GogToolAction *
diff --git a/goffice/math/go-matrix.c b/goffice/math/go-matrix.c
index f48639b5..519f2634 100644
--- a/goffice/math/go-matrix.c
+++ b/goffice/math/go-matrix.c
@@ -69,6 +69,10 @@ struct GOQuadQRl_ {
  **/
 /**
  * go_quad_matrix_newl: (skip)
+ * @m: number of rows
+ * @n: number of columns
+ *
+ * Returns: a new zero matrix.
  **/
 QMATRIX *
 SUFFIX(go_quad_matrix_new) (int m, int n)
@@ -104,9 +108,15 @@ SUFFIX(go_quad_matrix_free) (QMATRIX *A)
 
 /**
  * go_quad_matrix_dup: (skip)
+ * @A: Matrix to duplicate
+ *
+ * Returns: a new matrix.
  **/
 /**
  * go_quad_matrix_dupl: (skip)
+ * @A: Matrix to duplicate
+ *
+ * Returns: a new matrix.
  **/
 QMATRIX *
 SUFFIX(go_quad_matrix_dup) (const QMATRIX *A)
@@ -121,8 +131,15 @@ SUFFIX(go_quad_matrix_dup) (const QMATRIX *A)
 
 /**
  * go_quad_matrix_copy:
- * @A: Destination matrix.
- * @B: Source matrix.
+ * @A: (out): Destination matrix.
+ * @B: (transfer none): Source matrix.
+ *
+ * Copies B to A.
+ **/
+/**
+ * go_quad_matrix_copyl:
+ * @A: (out): Destination matrix.
+ * @B: (transfer none): Source matrix.
  *
  * Copies B to A.
  **/
@@ -145,8 +162,15 @@ SUFFIX(go_quad_matrix_copy) (QMATRIX *A, const QMATRIX *B)
 
 /**
  * go_quad_matrix_transpose:
- * @A: Destination matrix.
- * @B: Source matrix.
+ * @A: (out): Destination matrix.
+ * @B: (transfer none): Source matrix.
+ *
+ * Transposes B into A.
+ **/
+/**
+ * go_quad_matrix_transposel:
+ * @A: (out): Destination matrix.
+ * @B: (transfer none): Source matrix.
  *
  * Transposes B into A.
  **/
@@ -170,7 +194,15 @@ SUFFIX(go_quad_matrix_transpose) (QMATRIX *A, const QMATRIX *B)
 
 /**
  * go_quad_matrix_multiply:
- * @C: Destination matrix.
+ * @C: (out): Destination matrix.
+ * @A: Source matrix.
+ * @B: Source matrix.
+ *
+ * Multiplies A*B and stores the result in C.
+ **/
+/**
+ * go_quad_matrix_multiplyl:
+ * @C: (out): Destination matrix.
  * @A: Source matrix.
  * @B: Source matrix.
  *
@@ -209,13 +241,20 @@ SUFFIX(go_quad_matrix_multiply) (QMATRIX *C,
  * @threshold: condition number threshold.
  *
  * Returns: The inverse matrix of A.  If any eigenvalues divided by the largest
- * eigenvalue is less than or equal to the given threshold, %NULL is returning
+ * eigenvalue is less than or equal to the given threshold, %NULL is returned
  * indicating a matrix that cannot be inverted.  (Note: this doesn't actually
  * use the eigenvalues of A, but of A after an orthogonal transformation.)
  **/
 
 /**
  * go_quad_matrix_inversel: (skip)
+ * @A: Source matrix.
+ * @threshold: condition number threshold.
+ *
+ * Returns: The inverse matrix of A.  If any eigenvalues divided by the largest
+ * eigenvalue is less than or equal to the given threshold, %NULL is returned
+ * indicating a matrix that cannot be inverted.  (Note: this doesn't actually
+ * use the eigenvalues of A, but of A after an orthogonal transformation.)
  **/
 QMATRIX *
 SUFFIX(go_quad_matrix_inverse) (const QMATRIX *A, DOUBLE threshold)
@@ -310,10 +349,16 @@ SUFFIX(go_quad_matrix_determinant) (const QMATRIX *A, QUAD *res)
  * go_quad_matrix_pseudo_inverse: (skip)
  * @A: An arbitrary matrix.
  * @threshold: condition number threshold.
+ *
+ * Returns: @A's pseudo-inverse.
  **/
 
 /**
  * go_quad_matrix_pseudo_inversel: (skip)
+ * @A: An arbitrary matrix.
+ * @threshold: condition number threshold.
+ *
+ * Returns: @A's pseudo-inverse.
  **/
 QMATRIX *
 SUFFIX(go_quad_matrix_pseudo_inverse) (const QMATRIX *A, DOUBLE threshold)
@@ -462,6 +507,19 @@ out:
  *
  * This function solves the triangular system RT*x=b.
  **/
+/**
+ * go_quad_matrix_fwd_solvel:
+ * @R: An upper triangular matrix.
+ * @x: (out): Result vector.
+ * @b: Input vector.
+ * @allow_degenerate: If %TRUE, then degenerate dimensions are ignored other
+ * than being given a zero result.  A degenerate dimension is one whose
+ * diagonal entry is zero.
+ *
+ * Returns: %TRUE on error.
+ *
+ * This function solves the triangular system RT*x=b.
+ **/
 gboolean
 SUFFIX(go_quad_matrix_fwd_solve) (const QMATRIX *R, QUAD *x, const QUAD *b,
                                  gboolean allow_degenerate)
@@ -515,6 +573,19 @@ SUFFIX(go_quad_matrix_fwd_solve) (const QMATRIX *R, QUAD *x, const QUAD *b,
  *
  * This function solves the triangular system R*x=b.
  **/
+/**
+ * go_quad_matrix_back_solvel:
+ * @R: An upper triangular matrix.
+ * @x: (out): Result vector.
+ * @b: Input vector.
+ * @allow_degenerate: If %TRUE, then degenerate dimensions are ignored other
+ * than being given a zero result.  A degenerate dimension is one whose
+ * diagonal entry is zero.
+ *
+ * Returns: %TRUE on error.
+ *
+ * This function solves the triangular system R*x=b.
+ **/
 gboolean
 SUFFIX(go_quad_matrix_back_solve) (const QMATRIX *R, QUAD *x, const QUAD *b,
                                   gboolean allow_degenerate)
@@ -561,6 +632,12 @@ SUFFIX(go_quad_matrix_back_solve) (const QMATRIX *R, QUAD *x, const QUAD *b,
  * @emin: (out): Smallest absolute eigen value.
  * @emax: (out): Largest absolute eigen value.
  **/
+/**
+ * go_quad_matrix_eigen_rangel:
+ * @A: Triangular matrix.
+ * @emin: (out): Smallest absolute eigen value.
+ * @emax: (out): Largest absolute eigen value.
+ **/
 void
 SUFFIX(go_quad_matrix_eigen_range) (const QMATRIX *A,
                                    DOUBLE *emin, DOUBLE *emax)
@@ -619,6 +696,9 @@ SUFFIX(go_quad_matrix_dump) (const QMATRIX *A, const char *fmt)
 
 /**
  * go_quad_qr_newl: (skip)
+ * @A: input matrix
+ *
+ * Returns: (transfer full): qr decomposition.
  **/
 QQR *
 SUFFIX(go_quad_qr_new) (const QMATRIX *A)
@@ -742,6 +822,13 @@ SUFFIX(go_quad_qr_determinant) (const QQR *qr, QUAD *det)
  * Returns: the small R from the decomposition, i.e., a square matrix
  * of size n.  To get the large R, if needed, add m-n zero rows.
  **/
+/**
+ * go_quad_qr_rl:
+ * @qr: A QR decomposition.
+ *
+ * Returns: the small R from the decomposition, i.e., a square matrix
+ * of size n.  To get the large R, if needed, add m-n zero rows.
+ **/
 const QMATRIX *
 SUFFIX(go_quad_qr_r) (const QQR *qr)
 {
@@ -757,6 +844,13 @@ SUFFIX(go_quad_qr_r) (const QQR *qr)
  *
  * Replaces @x by Q^t * x
  **/
+/**
+ * go_quad_qr_multiply_qtl:
+ * @qr: A QR decomposition.
+ * @x: (inout): a vector.
+ *
+ * Replaces @x by Q^t * x
+ **/
 void
 SUFFIX(go_quad_qr_multiply_qt) (const QQR *qr, QUAD *x)
 {
@@ -787,6 +881,14 @@ SUFFIX(go_quad_qr_multiply_qt) (const QQR *qr, QUAD *x)
  * Marks dimension i of the qr decomposition as degenerate.  In practice
  * this means setting the i-th eigenvalue of R to zero.
  **/
+/**
+ * go_quad_qr_mark_degeneratel: (skip)
+ * @qr: A QR decomposition.
+ * @i: a dimension
+ *
+ * Marks dimension i of the qr decomposition as degenerate.  In practice
+ * this means setting the i-th eigenvalue of R to zero.
+ **/
 void
 SUFFIX(go_quad_qr_mark_degenerate) (QQR *qr, int i)
 {
diff --git a/goffice/math/go-rangefunc.c b/goffice/math/go-rangefunc.c
index 63c61cbb..f3350454 100644
--- a/goffice/math/go-rangefunc.c
+++ b/goffice/math/go-rangefunc.c
@@ -68,8 +68,15 @@ SUFFIX(sum_helper) (DOUBLE const *xs, int n)
        return acc;
 }
 
-
-/* Arithmetic sum.  */
+/**
+ * go_range_sum:
+ * @xs: (array length=n): values.
+ * @n: number of values
+ * @res: (out): result.
+ *
+ * Returns: 0 unless an error occurred.  The arithmetic sum of the input
+ * values will be stored in @res.
+ */
 int
 SUFFIX(go_range_sum) (DOUBLE const *xs, int n, DOUBLE *res)
 {
@@ -81,7 +88,15 @@ SUFFIX(go_range_sum) (DOUBLE const *xs, int n, DOUBLE *res)
        return 0;
 }
 
-/* Arithmetic sum of squares.  */
+/**
+ * go_range_sumsq:
+ * @xs: (array length=n): values.
+ * @n: number of values
+ * @res: (out): result.
+ *
+ * Returns: 0 unless an error occurred.  The arithmetic sum of the squares
+ * of the input values will be stored in @res.
+ */
 int
 SUFFIX(go_range_sumsq) (DOUBLE const *xs, int n, DOUBLE *res)
 {
@@ -99,7 +114,15 @@ SUFFIX(go_range_sumsq) (DOUBLE const *xs, int n, DOUBLE *res)
        return 0;
 }
 
-/* Arithmetic average.  */
+/**
+ * go_range_average:
+ * @xs: (array length=n): values.
+ * @n: number of values
+ * @res: (out): result.
+ *
+ * Returns: 0 unless an error occurred.  The average of
+ * the input values will be stored in @res.
+ */
 int
 SUFFIX(go_range_average) (DOUBLE const *xs, int n, DOUBLE *res)
 {
@@ -116,7 +139,15 @@ SUFFIX(go_range_average) (DOUBLE const *xs, int n, DOUBLE *res)
        return 0;
 }
 
-/* Minimum element.  */
+/**
+ * go_range_min:
+ * @xs: (array length=n): values.
+ * @n: number of values
+ * @res: (out): result.
+ *
+ * Returns: 0 unless an error occurred.  The minimum of
+ * the input values will be stored in @res.
+ */
 int
 SUFFIX(go_range_min) (DOUBLE const *xs, int n, DOUBLE *res)
 {
@@ -133,7 +164,15 @@ SUFFIX(go_range_min) (DOUBLE const *xs, int n, DOUBLE *res)
                return 1;
 }
 
-/* Maximum element.  */
+/**
+ * go_range_max:
+ * @xs: (array length=n): values.
+ * @n: number of values
+ * @res: (out): result.
+ *
+ * Returns: 0 unless an error occurred.  The maximum of
+ * the input values will be stored in @res.
+ */
 int
 SUFFIX(go_range_max) (DOUBLE const *xs, int n, DOUBLE *res)
 {
@@ -150,7 +189,15 @@ SUFFIX(go_range_max) (DOUBLE const *xs, int n, DOUBLE *res)
                return 1;
 }
 
-/* Maximum absolute element.  */
+/**
+ * go_range_maxabs:
+ * @xs: (array length=n): values.
+ * @n: number of values
+ * @res: (out): result.
+ *
+ * Returns: 0 unless an error occurred.  The maximum of the absolute
+ * values of the input values will be stored in @res.
+ */
 int
 SUFFIX(go_range_maxabs) (DOUBLE const *xs, int n, DOUBLE *res)
 {
@@ -169,7 +216,15 @@ SUFFIX(go_range_maxabs) (DOUBLE const *xs, int n, DOUBLE *res)
                return 1;
 }
 
-/* Sum of square deviations from mean.  */
+/**
+ * go_range_devsq:
+ * @xs: (array length=n): values.
+ * @n: number of values
+ * @res: (out): result.
+ *
+ * Returns: 0 unless an error occurred.  The sum of the input
+ * values deviation from the mean will be stored in @res.
+ */
 int
 SUFFIX(go_range_devsq) (DOUBLE const *xs, int n, DOUBLE *res)
 {
@@ -238,7 +293,17 @@ SUFFIX(go_range_sort) (DOUBLE const *xs, int n)
                return ys;
        }
 }
-/* This requires sorted data.  */
+
+/**
+ * go_range_fractile_inter_sorted:
+ * @xs: (array length=n): values, which must be sorted.
+ * @n: number of values
+ * @res: (out): result.
+ * @f: fractile
+ *
+ * Returns: 0 unless an error occurred.  This function computes
+ * the interpolated fractile given by @f and stores it in @res.
+ */
 int
 SUFFIX(go_range_fractile_inter_sorted) (DOUBLE const *xs, int n, DOUBLE *res, DOUBLE f)
 {
@@ -260,6 +325,16 @@ SUFFIX(go_range_fractile_inter_sorted) (DOUBLE const *xs, int n, DOUBLE *res, DO
        return 0;
 }
 
+/**
+ * go_range_fractile_inter:
+ * @xs: (array length=n): values.
+ * @n: number of values
+ * @res: (out): result.
+ * @f: fractile
+ *
+ * Returns: 0 unless an error occurred.  This function computes
+ * the interpolated fractile given by @f and stores it in @res.
+ */
 int
 SUFFIX(go_range_fractile_inter) (DOUBLE const *xs, int n, DOUBLE *res, DOUBLE f)
 {
@@ -276,12 +351,30 @@ SUFFIX(go_range_fractile_inter_nonconst) (DOUBLE *xs, int n, DOUBLE *res, DOUBLE
        return SUFFIX(go_range_fractile_inter_sorted) (xs, n, res, f);
 }
 
+/**
+ * go_range_median_inter:
+ * @xs: (array length=n): values.
+ * @n: number of values
+ * @res: (out): result.
+ *
+ * Returns: 0 unless an error occurred.  This function computes
+ * the interpolated median and stores it in @res.
+ */
 int
 SUFFIX(go_range_median_inter) (DOUBLE const *xs, int n, DOUBLE *res)
 {
        return SUFFIX(go_range_fractile_inter) (xs, n, res, 0.5);
 }
 
+/**
+ * go_range_median_inter_sorted:
+ * @xs: (array length=n): values, which must be sorted.
+ * @n: number of values
+ * @res: (out): result.
+ *
+ * Returns: 0 unless an error occurred.  This function computes
+ * the interpolated median and stores it in @res.
+ */
 int
 SUFFIX(go_range_median_inter_sorted) (DOUBLE const *xs, int n, DOUBLE *res)
 {
@@ -294,6 +387,13 @@ SUFFIX(go_range_median_inter_nonconst) (DOUBLE *xs, int n, DOUBLE *res)
        return SUFFIX(go_range_fractile_inter_nonconst) (xs, n, res, 0.5);
 }
 
+/**
+ * go_range_constant:
+ * @xs: (array length=n): values.
+ * @n: number of values
+ *
+ * Returns: 1 if range is constant, 0 otherwise.
+ */
 int
 SUFFIX(go_range_constant) (DOUBLE const *xs, int n)
 {
@@ -304,6 +404,13 @@ SUFFIX(go_range_constant) (DOUBLE const *xs, int n)
        return 1;
 }
 
+/**
+ * go_range_increasing:
+ * @xs: (array length=n): values.
+ * @n: number of values
+ *
+ * Returns: 1 if range is increasing, 0 otherwise.
+ */
 int
 SUFFIX(go_range_increasing) (DOUBLE const *xs, int n)
 {
@@ -325,6 +432,13 @@ SUFFIX(go_range_increasing) (DOUBLE const *xs, int n)
        return 1;
 }
 
+/**
+ * go_range_decreasing:
+ * @xs: (array length=n): values.
+ * @n: number of values
+ *
+ * Returns: 1 if range is decreasing, 0 otherwise.
+ */
 int
 SUFFIX(go_range_decreasing) (DOUBLE const *xs, int n)
 {
@@ -346,6 +460,13 @@ SUFFIX(go_range_decreasing) (DOUBLE const *xs, int n)
        return 1;
 }
 
+/**
+ * go_range_vary_uniformly:
+ * @xs: (array length=n): values.
+ * @n: number of values
+ *
+ * Returns: 1 if range is either decreasing or increasing, 0 otherwise.
+ */
 int
 SUFFIX(go_range_vary_uniformly) (DOUBLE const *xs, int n)
 {
diff --git a/goffice/utils/go-line.c b/goffice/utils/go-line.c
index e215c63f..9521d485 100644
--- a/goffice/utils/go-line.c
+++ b/goffice/utils/go-line.c
@@ -29,17 +29,17 @@
  * GOLineDashType:
  * @GO_LINE_NONE: No line displayed.
  * @GO_LINE_SOLID: Solid line.
- * @GO_LINE_S_DOT:
- * @GO_LINE_S_DASH_DOT:
- * @GO_LINE_S_DASH_DOT_DOT:
- * @GO_LINE_DASH_DOT_DOT_DOT:
- * @GO_LINE_DOT:
- * @GO_LINE_S_DASH:
- * @GO_LINE_DASH:
- * @GO_LINE_LONG_DASH:
- * @GO_LINE_DASH_DOT:
- * @GO_LINE_DASH_DOT_DOT:
- * @GO_LINE_MAX:
+ * @GO_LINE_S_DOT: Line with dot pattern.
+ * @GO_LINE_S_DASH_DOT: Line with dash-dot pattern.
+ * @GO_LINE_S_DASH_DOT_DOT: Line with dash-dot-dot pattern.
+ * @GO_LINE_DASH_DOT_DOT_DOT: Line with dash-dot-dot-dot pattern.
+ * @GO_LINE_DOT: Dotted line.
+ * @GO_LINE_S_DASH: Line with short dashes.
+ * @GO_LINE_DASH: Line with dash pattern
+ * @GO_LINE_LONG_DASH: Line with long dashes.
+ * @GO_LINE_DASH_DOT: Line with dash-dot pattern.
+ * @GO_LINE_DASH_DOT_DOT: Line with dash-dot-dot pattern.
+ * @GO_LINE_MAX: Number of line dash types
  **/
 
 /**
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]