[gnumeric] Introspection: doc fixes.



commit 7ebcf3ea327e95158a59085fc0e5638401c1d5b0
Author: Morten Welinder <terra gnome org>
Date:   Fri Mar 1 15:38:27 2013 -0500

    Introspection: doc fixes.

 plugins/fn-r/generate |    2 -
 src/mathfunc.h        |    4 +-
 src/outoflinedocs.c   |   77 +++++++++++++++++++++++++++++++++++++++++++++++--
 3 files changed, 76 insertions(+), 7 deletions(-)
---
diff --git a/plugins/fn-r/generate b/plugins/fn-r/generate
index 7abcc6f..e867ed1 100644
--- a/plugins/fn-r/generate
+++ b/plugins/fn-r/generate
@@ -44,8 +44,6 @@ my %argoverride = ();
        [\&distribution,
         'gamma',
         ({ @common })];
-    $argoverride{"pgamma:p"} = "shape";
-    $argoverride{"qgamma:alpha"} = "shape";
 
     $funcs{'dbeta'} = $funcs{'pbeta'} = $funcs{'qbeta'} =
        [\&distribution,
diff --git a/src/mathfunc.h b/src/mathfunc.h
index 2a0e0a1..d015f2a 100644
--- a/src/mathfunc.h
+++ b/src/mathfunc.h
@@ -62,8 +62,8 @@ gnm_float qlnorm (gnm_float p, gnm_float logmean, gnm_float logsd, gboolean lowe
 
 /* The gamma distribution.  */
 gnm_float dgamma (gnm_float x, gnm_float shape, gnm_float scale, gboolean give_log);
-gnm_float pgamma (gnm_float x, gnm_float p, gnm_float scale, gboolean lower_tail, gboolean log_p);
-gnm_float qgamma (gnm_float p, gnm_float alpha, gnm_float scale, gboolean lower_tail, gboolean log_p);
+gnm_float pgamma (gnm_float x, gnm_float shape, gnm_float scale, gboolean lower_tail, gboolean log_p);
+gnm_float qgamma (gnm_float p, gnm_float shape, gnm_float scale, gboolean lower_tail, gboolean log_p);
 
 /* The beta distribution.  */
 gnm_float dbeta (gnm_float x, gnm_float a, gnm_float b, gboolean give_log);
diff --git a/src/outoflinedocs.c b/src/outoflinedocs.c
index 4f5feeb..0f545e6 100644
--- a/src/outoflinedocs.c
+++ b/src/outoflinedocs.c
@@ -43,7 +43,7 @@
  * @sigma: standard deviation of the distribution
  * @give_log: if %TRUE, log of the result will be returned instead
  *
- * Returns: density of the normal distribution
+ * Returns: density of the normal distribution.
  */
 
 /**
@@ -54,7 +54,7 @@
  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
  * @log_p: if %TRUE, log of the result will be returned instead
  *
- * Returns: cumulative density of the normal distribution
+ * Returns: cumulative density of the normal distribution.
  */
 
 /**
@@ -65,7 +65,78 @@
  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
  * @log_p: if %TRUE, @p is given as log probability
  *
- * Returns: the observation with cumulative probability @p.
+ * Returns: the observation with cumulative probability @p for the
+ * normal distribution.
+ */
+
+/* ------------------------------------------------------------------------- */
+
+/**
+ * dlnorm:
+ * @x: observation
+ * @logmean: mean of the underlying normal distribution
+ * @logsd: standard deviation of the underlying normal distribution
+ * @give_log: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: density of the normal distribution.
+ */
+
+/**
+ * plnorm:
+ * @x: observation
+ * @logmean: mean of the underlying normal distribution
+ * @logsd: standard deviation of the underlying normal distribution
+ * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
+ * @log_p: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: cumulative density of the normal distribution.
+ */
+
+/**
+ * qlnorm:
+ * @p: probability
+ * @logmean: mean of the underlying normal distribution
+ * @logsd: standard deviation of the underlying normal distribution
+ * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
+ * @log_p: if %TRUE, @p is given as log probability
+ *
+ * Returns: the observation with cumulative probability @p for the
+ * log normal distribution.
+ */
+
+/* ------------------------------------------------------------------------- */
+
+/**
+ * dgamma:
+ * @x: observation
+ * @shape: the shape parameter of the distribution
+ * @scale: the scale parameter of the distribution
+ * @give_log: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: density of the gamma distribution.
+ */
+
+/**
+ * pgamma:
+ * @x: observation
+ * @shape: the shape parameter of the distribution
+ * @scale: the scale parameter of the distribution
+ * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
+ * @log_p: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: cumulative density of the gamma distribution.
+ */
+
+/**
+ * qgamma:
+ * @p: probability
+ * @shape: the shape parameter of the distribution
+ * @scale: the scale parameter of the distribution
+ * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
+ * @log_p: if %TRUE, @p is given as log probability
+ *
+ * Returns: the observation with cumulative probability @p for the
+ * gamma distribution.
  */
 
 /* ------------------------------------------------------------------------- */


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