[gnumeric] Docs: regenerate docs for new functions.
- From: Morten Welinder <mortenw src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnumeric] Docs: regenerate docs for new functions.
- Date: Sun, 18 Nov 2018 00:59:28 +0000 (UTC)
commit 1f36db40f3871d65a9eb750f1a547479f4655d46
Author: Morten Welinder <terra gnome org>
Date: Sat Nov 17 19:58:25 2018 -0500
Docs: regenerate docs for new functions.
doc/C/func.defs | 19 ++++++++++++++-
doc/C/functions.xml | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
2 files changed, 84 insertions(+), 2 deletions(-)
---
diff --git a/doc/C/func.defs b/doc/C/func.defs
index 2d4f14490..a93014ba9 100644
--- a/doc/C/func.defs
+++ b/doc/C/func.defs
@@ -3076,7 +3076,7 @@ The depreciation coefficient used is:
@CATEGORY=Lookup
@FUNCTION=INDEX
@SHORTDESC=reference to a cell in the given @{array}
-@SYNTAX=INDEX(array,row,col,area)
+@SYNTAX=INDEX(array,row,col,area,…)
@ARGUMENTDESCRIPTION=@{array}: cell or inline array
@{row}: desired row, defaults to 1
@{col}: desired column, defaults to 1
@@ -3614,6 +3614,15 @@ The depreciation coefficient used is:
@EXCEL=This function is Excel compatible.
@SEEALSO=CEIL,CEILING,FLOOR,ABS,MOD
+@CATEGORY=Mathematics
+@FUNCTION=LAMBERTW
+@SHORTDESC=the Lambert W function
+@SYNTAX=LAMBERTW(x,k)
+@ARGUMENTDESCRIPTION=@{x}: number
+@{k}: branch
+@NOTE=@{k} defaults to 0, the principal branch. @{k} must be either 0 or -1.
+@SEEALSO=EXP
+
@CATEGORY=Mathematics
@FUNCTION=LCM
@SHORTDESC=the least common multiple
@@ -4164,6 +4173,14 @@ Strings and empty cells are simply ignored.
@DESCRIPTION=NT_PI returns the number of primes less than or equal to @{n}.
@SEEALSO=ITHPRIME,NT_PHI,NT_D,NT_SIGMA
+@CATEGORY=Number Theory
+@FUNCTION=NT_RADICAL
+@SHORTDESC=Radical function
+@SYNTAX=NT_RADICAL(n)
+@ARGUMENTDESCRIPTION=@{n}: positive integer
+@NOTE=The function computes the product of its distinct prime factors
+@SEEALSO=NT_D,ITHPRIME,NT_SIGMA
+
@CATEGORY=Number Theory
@FUNCTION=NT_SIGMA
@SHORTDESC=sigma function
diff --git a/doc/C/functions.xml b/doc/C/functions.xml
index 72d829235..ae493e6a3 100644
--- a/doc/C/functions.xml
+++ b/doc/C/functions.xml
@@ -9864,7 +9864,7 @@
</refpurpose>
</refnamediv>
<refsynopsisdiv>
-
<synopsis><function>INDEX</function>(<parameter>array</parameter>,<parameter>row</parameter>,<parameter>col</parameter>,<parameter>area</parameter>)</synopsis>
+
<synopsis><function>INDEX</function>(<parameter>array</parameter>,<parameter>row</parameter>,<parameter>col</parameter>,<parameter>area</parameter>,<parameter/>…)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Arguments</title>
@@ -11938,6 +11938,38 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-function-LAMBERTW">
+ <refmeta>
+ <refentrytitle>
+ <function>LAMBERTW</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LAMBERTW</function>
+ </refname>
+ <refpurpose>
+ the Lambert W function
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LAMBERTW</function>(<parameter>x</parameter>,<parameter>k</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Arguments</title>
+ <para><parameter>x</parameter>: number</para>
+ <para><parameter>k</parameter>: branch</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>k</parameter> defaults to 0, the principal branch. <parameter>k</parameter> must be
either 0 or -1.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-function-EXP"><function>EXP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-function-LCM">
<refmeta>
<refentrytitle>
@@ -14033,6 +14065,39 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-function-NT_RADICAL">
+ <refmeta>
+ <refentrytitle>
+ <function>NT_RADICAL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NT_RADICAL</function>
+ </refname>
+ <refpurpose>
+ Radical function
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NT_RADICAL</function>(<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Arguments</title>
+ <para><parameter>n</parameter>: positive integer</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The function computes the product of its distinct prime factors</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-function-NT_D"><function>NT_D</function></link>,
+ <link linkend="gnumeric-function-ITHPRIME"><function>ITHPRIME</function></link>,
+ <link linkend="gnumeric-function-NT_SIGMA"><function>NT_SIGMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-function-NT_SIGMA">
<refmeta>
<refentrytitle>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]