[gnumeric] Introspection: fixes and updates.



commit 18d26f0928673010920e36435df745645d2fdbde
Author: Morten Welinder <terra gnome org>
Date:   Wed Mar 8 10:25:50 2017 -0500

    Introspection: fixes and updates.

 src/mstyle.c   |   33 ++++++++++++++++++++++++++++-----
 src/mstyle.h   |    2 +-
 src/sf-gamma.c |   16 ++++++++++------
 3 files changed, 39 insertions(+), 12 deletions(-)
---
diff --git a/src/mstyle.c b/src/mstyle.c
index f6a5590..c85b136 100644
--- a/src/mstyle.c
+++ b/src/mstyle.c
@@ -1819,17 +1819,19 @@ gnm_style_get_validation (GnmStyle const *style)
 /**
  * gnm_style_set_hlink:
  * @style: #GnmStyle
- * @link: (transfer full): #GnmHLink
+ * @lnk: (transfer full): #GnmHLink
+ *
+ * This sets a link for @style.
  **/
 void
-gnm_style_set_hlink (GnmStyle *style, GnmHLink *link)
+gnm_style_set_hlink (GnmStyle *style, GnmHLink *lnk)
 {
        g_return_if_fail (style != NULL);
 
        elem_clear_contents (style, MSTYLE_HLINK);
        elem_changed (style, MSTYLE_HLINK);
        elem_set (style, MSTYLE_HLINK);
-       style->hlink = link;
+       style->hlink = lnk;
 }
 
 /**
@@ -1851,6 +1853,8 @@ gnm_style_get_hlink (GnmStyle const *style)
  * gnm_style_set_input_msg:
  * @style: #GnmStyle
  * @msg: (transfer full): #GnmInputMsg
+ *
+ * This sets an input message for @style.
  **/
 void
 gnm_style_set_input_msg (GnmStyle *style, GnmInputMsg *msg)
@@ -1867,7 +1871,8 @@ gnm_style_set_input_msg (GnmStyle *style, GnmInputMsg *msg)
  * gnm_style_get_input_msg:
  * @style: #GnmStyle
  *
- * Returns: (transfer none):
+ * Returns: (transfer none): the currently set input message assuming
+ * that the style has such.
  **/
 GnmInputMsg *
 gnm_style_get_input_msg (GnmStyle const *style)
@@ -1882,6 +1887,8 @@ gnm_style_get_input_msg (GnmStyle const *style)
  * gnm_style_set_conditions:
  * @style: #GnmStyle
  * @sc: (transfer full): #GnmStyleConditions
+ *
+ * This sets conditional style for @style.
  **/
 void
 gnm_style_set_conditions (GnmStyle *style, GnmStyleConditions *sc)
@@ -1898,7 +1905,8 @@ gnm_style_set_conditions (GnmStyle *style, GnmStyleConditions *sc)
  * gnm_style_get_conditions:
  * @style: #GnmStyle
  *
- * Returns: (transfer none):
+ * Returns: (transfer none): the currently set conditional style assuming
+ * that the style has such.
  **/
 GnmStyleConditions *
 gnm_style_get_conditions (GnmStyle const *style)
@@ -2023,6 +2031,13 @@ gnm_style_unlink_dependents (GnmStyle *style, GnmRange const *r)
 }
 
 
+/**
+ * gnm_style_visible_in_blank:
+ * @style: style to query
+ *
+ * Returns: %TRUE if the style is visible, i.e., not transparent.  Specifically
+ * that means if it has a background or a visible border.
+ */
 gboolean
 gnm_style_visible_in_blank (GnmStyle const *style)
 {
@@ -2261,6 +2276,14 @@ gnm_style_dump_border (GnmBorder *border, GnmStyleElement elem)
                g_printerr ("blank\n");
 }
 
+/**
+ * gnm_style_dump:
+ * @style: style to dump
+ *
+ * This function dumps the given style's contents to stderr.  This is meant
+ * for debug purposes only and doesn't do a very good job for, for example,
+ * conditional style settings.
+ */
 void
 gnm_style_dump (GnmStyle const *style)
 {
diff --git a/src/mstyle.h b/src/mstyle.h
index 9fe11ce..17c4b64 100644
--- a/src/mstyle.h
+++ b/src/mstyle.h
@@ -152,7 +152,7 @@ void                 gnm_style_set_validation       (GnmStyle *style, GnmValidation *v);
 GnmValidation const *
                 gnm_style_get_validation       (GnmStyle const *style);
 
-void            gnm_style_set_hlink            (GnmStyle *style, GnmHLink *link);
+void            gnm_style_set_hlink            (GnmStyle *style, GnmHLink *lnk);
 GnmHLink       *gnm_style_get_hlink            (GnmStyle const *style);
 
 void            gnm_style_set_input_msg        (GnmStyle *style, GnmInputMsg *msg);
diff --git a/src/sf-gamma.c b/src/sf-gamma.c
index 57e921a..d95b0cb 100644
--- a/src/sf-gamma.c
+++ b/src/sf-gamma.c
@@ -797,14 +797,18 @@ pochhammer_naive (gnm_float x, int n)
        return r;
 }
 
-
-
-/*
- * Pochhammer's symbol: (x)_n = Gamma(x+n)/Gamma(x).
+/**
+ * pochhammer:
+ * @x: a real number
+ * @n: a real number, often an integer
+ *
+ * This function computes Pochhammer's symbol at @x and @n, i.e.,
+ * Gamma(@x+@n)/Gamma(@x).  This is well defined unless @x or @x+@n is a
+ * non-negative integer.  The ratio has a removable singlularity at @n=0
+ * and the result is 1.
  *
- * While n is often an integer, that is not a requirement.
+ * Returns: Pochhammer's symbol (@x)_@n.
  */
-
 gnm_float
 pochhammer (gnm_float x, gnm_float n)
 {


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