[gnumeric] Docs: make a home for introspection docs for imported source code.



commit e63b6e192dea1a5282c0c2f4f2e26c25818e86e1
Author: Morten Welinder <terra gnome org>
Date:   Wed Feb 27 09:00:52 2013 -0500

    Docs: make a home for introspection docs for imported source code.

 src/Makefile.am     |    1 +
 src/outoflinedocs.c |   69 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 70 insertions(+), 0 deletions(-)
---
diff --git a/src/Makefile.am b/src/Makefile.am
index 514b7dc..3b3cbfb 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -137,6 +137,7 @@ libspreadsheet_la_SOURCES =                 \
        mathfunc.c                              \
        mstyle.c                                \
        number-match.c                          \
+       outoflinedocs.c                         \
        parser.y                                \
        parse-util.c                            \
        pattern.c                               \
diff --git a/src/outoflinedocs.c b/src/outoflinedocs.c
new file mode 100644
index 0000000..78a9873
--- /dev/null
+++ b/src/outoflinedocs.c
@@ -0,0 +1,69 @@
+/*
+ * Documentation for those functions where inline documentation is
+ * not appropriate, for example because the source code was imported
+ * from elsewhere.
+ */
+
+/* ------------------------------------------------------------------------- */
+
+/**
+ * log1pmx
+ * @x: a number
+ *
+ * Returns: log(1+ x)- x with less rounding error than the naive formula,
+ * especially for small values of @x.
+ */
+
+
+/**
+ * pow1p:
+ * @x: a number
+ * @y: a number
+ *
+ * Returns: (1+ x)^ y with less rounding error than the naive formula.
+ */
+
+
+/**
+ * pow1pm1:
+ * @x: a number
+ * @y: a number
+ *
+ * Returns: (1+ x)^ y-1 with less rounding error than the naive formula.
+ */
+
+/* ------------------------------------------------------------------------- */
+
+/**
+ * dnorm: the density function of the normal distribution
+ * @x: observation
+ * @mu: mean of the distribution
+ * @sigma: standard deviation of the distribution
+ * @give_log: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: density of the normal distribution
+ */
+
+/**
+ * pnorm: the cumulative density function of the normal distribution
+ * @x: observation
+ * @mu: mean of the distribution
+ * @sigma: standard deviation 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 normal distribution
+ */
+
+/**
+ * qnorm: the probability quantile function of the normal distribution
+ * @p: probability
+ * @mu: mean of the distribution
+ * @sigma: standard deviation 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.
+ */
+
+/* ------------------------------------------------------------------------- */


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