GNOME.org
 

[gnumeric] Docs: propagate some function docs.

commit c81c6d9481db47933b9f628625b837756ad29faa
Author: Morten Welinder <terra gnome org>
Date:   Mon Jun 25 20:02:14 2012 -0400

    Docs: propagate some function docs.

 doc/C/func.defs     |   31 ++++++++++++++++------
 doc/C/functions.xml |   71 ++++++++++++++++++++++++++++++++++++++++++++------
 2 files changed, 84 insertions(+), 18 deletions(-)
---
diff --git a/doc/C/func.defs b/doc/C/func.defs
index 71e7eff5..0f57c60 100644
--- a/doc/C/func.defs
+++ b/doc/C/func.defs
@@ -836,6 +836,18 @@ The natural logarithm is not uniquely defined on complex numbers. You may need t
 @SEEALSO=DATE
 
 @CATEGORY=Date/Time
+ FUNCTION=TIME
+ SHORTDESC=create a time serial value
+ SYNTAX=TIME(hour,minute,second)
+ ARGUMENTDESCRIPTION=@{hour}: hour
+ {minute}: minute
+ {second}: second
+ DESCRIPTION=The ODF.TIME function computes the time given by @{hour}, @{minute}, and @{second} as a fraction of a day.
+ NOTE=While the return value is automatically formatted to look like a time between 0:00 and 24:00, the underlying serial time value can be any number.
+ ODF=This function is OpenFormula compatible.
+ SEEALSO=TIME,HOUR,MINUTE,SECOND
+
+ CATEGORY=Date/Time
 @FUNCTION=PENTECOSTSUNDAY
 @SHORTDESC=Pentecost Sunday in the Gregorian calendar according to the Roman rite of the Christian Church
 @SYNTAX=PENTECOSTSUNDAY(year)
@@ -859,9 +871,10 @@ The natural logarithm is not uniquely defined on complex numbers. You may need t
 @ARGUMENTDESCRIPTION= {hour}: hour of the day
 @{minute}: minute within the hour
 @{second}: second within the minute
- DESCRIPTION=The TIME function computes the fractional day between midnight at the time given by @{hour}, @{minute}, and @{second}.
+ DESCRIPTION=The TIME function computes the fractional day after midnight at the time given by @{hour}, @{minute}, and @{second}.
+ NOTE=While the return value is automatically formatted to look like a time between 0:00 and 24:00, the underlying serial time value is a number between 0 and 1. If any of @{hour}, @{minute}, and @{second} is negative, #NUM! is returned
 @EXCEL=This function is Excel compatible.
- SEEALSO=HOUR,MINUTE,SECOND
+ SEEALSO=ODF TIME,HOUR,MINUTE,SECOND
 
 @CATEGORY=Date/Time
 @FUNCTION=TIMEVALUE
@@ -1560,7 +1573,7 @@ The depreciation coefficient used is:
 
 @CATEGORY=Finance
 @FUNCTION=DURATION
- SHORTDESC=the duration of a security
+ SHORTDESC=the (Macaulay) duration of a security
 @SYNTAX=DURATION(settlement,maturity,coupon,yield,frequency,basis)
 @ARGUMENTDESCRIPTION= {settlement}: settlement date
 @{maturity}: maturity date
@@ -1568,9 +1581,9 @@ The depreciation coefficient used is:
 @{yield}: annual yield of security
 @{frequency}: number of interest payments per year
 @{basis}: calendar basis
- DESCRIPTION=DURATION calculates the duration of a security.
+ DESCRIPTION=DURATION calculates the (Macaulay) duration of a security.
 @NOTE= {frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used.
- SEEALSO=MDURATION
+ SEEALSO=MDURATION, G_DURATION
 
 @CATEGORY=Finance
 @FUNCTION=EFFECT
@@ -1634,7 +1647,7 @@ The depreciation coefficient used is:
 @{fv}: future value
 @DESCRIPTION=G_DURATION calculates the number of periods needed for an investment to attain a desired value.
 @ODF=G_DURATION is the OpenFormula function PDURATION.
- SEEALSO=FV,PV
+ SEEALSO=FV,PV,DURATION,MDURATION
 
 @CATEGORY=Finance
 @FUNCTION=INTRATE
@@ -1686,7 +1699,7 @@ The depreciation coefficient used is:
 
 @CATEGORY=Finance
 @FUNCTION=MDURATION
- SHORTDESC=the Macaulay duration of a security
+ SHORTDESC=the modified (Macaulay) duration of a security
 @SYNTAX=MDURATION(settlement,maturity,coupon,yield,frequency,basis)
 @ARGUMENTDESCRIPTION= {settlement}: settlement date
 @{maturity}: maturity date
@@ -1694,9 +1707,9 @@ The depreciation coefficient used is:
 @{yield}: annual yield of security
 @{frequency}: number of interest payments per year
 @{basis}: calendar basis
- DESCRIPTION=MDURATION calculates the Macaulay duration of a security.
+ DESCRIPTION=MDURATION calculates the modified (Macaulay) duration of a security.
 @NOTE= {frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used.
- SEEALSO=DURATION
+ SEEALSO=DURATION,G_DURATION
 
 @CATEGORY=Finance
 @FUNCTION=MIRR
diff --git a/doc/C/functions.xml b/doc/C/functions.xml
index 28465c0..ae8a41d 100644
--- a/doc/C/functions.xml
+++ b/doc/C/functions.xml
@@ -3067,6 +3067,50 @@
       </para>
       </refsect1>
     </refentry>
+    <refentry id="gnumeric-function-TIME">
+      <refmeta>
+        <refentrytitle>
+          <function>TIME</function>
+        </refentrytitle>
+      </refmeta>
+      <refnamediv>
+        <refname>
+          <function>TIME</function>
+        </refname>
+        <refpurpose>
+        create a time serial value
+      </refpurpose>
+      </refnamediv>
+      <refsynopsisdiv>
+        <synopsis><function>TIME</function>(<parameter>hour</parameter>,<parameter>minute</parameter>,<parameter>second</parameter>)</synopsis>
+      </refsynopsisdiv>
+      <refsect1>
+        <title>Arguments</title>
+        <para><parameter>hour</parameter>: hour</para>
+        <para><parameter>minute</parameter>: minute</para>
+        <para><parameter>second</parameter>: second</para>
+      </refsect1>
+      <refsect1>
+        <title>Description</title>
+        <para>The ODF.<function>TIME</function> function computes the time given by <parameter>hour</parameter>, <parameter>minute</parameter>, and <parameter>second</parameter> as a fraction of a day.</para>
+      </refsect1>
+      <refsect1>
+        <title>Note</title>
+        <para>While the return value is automatically formatted to look like a time between 0:00 and 24:00, the underlying serial time value can be any number.</para>
+      </refsect1>
+      <refsect1>
+        <title>OpenDocument Format (ODF) Compatibility</title>
+        <para>This function is OpenFormula compatible.</para>
+      </refsect1>
+      <refsect1>
+        <title>See also</title>
+        <para><link linkend="gnumeric-function-TIME"><function>TIME</function></link>,
+        <link linkend="gnumeric-function-HOUR"><function>HOUR</function></link>,
+        <link linkend="gnumeric-function-MINUTE"><function>MINUTE</function></link>,
+        <link linkend="gnumeric-function-SECOND"><function>SECOND</function></link>.
+      </para>
+      </refsect1>
+    </refentry>
     <refentry id="gnumeric-function-PENTECOSTSUNDAY">
       <refmeta>
         <refentrytitle>
@@ -3160,7 +3204,11 @@
       </refsect1>
       <refsect1>
         <title>Description</title>
-        <para>The <function>TIME</function> function computes the fractional day between midnight at the time given by <parameter>hour</parameter>, <parameter>minute</parameter>, and <parameter>second</parameter>.</para>
+        <para>The <function>TIME</function> function computes the fractional day after midnight at the time given by <parameter>hour</parameter>, <parameter>minute</parameter>, and <parameter>second</parameter>.</para>
+      </refsect1>
+      <refsect1>
+        <title>Note</title>
+        <para>While the return value is automatically formatted to look like a time between 0:00 and 24:00, the underlying serial time value is a number between 0 and 1. If any of <parameter>hour</parameter>, <parameter>minute</parameter>, and <parameter>second</parameter> is negative, #NUM! is returned</para>
       </refsect1>
       <refsect1>
         <title>Microsoft Excel Compatibility</title>
@@ -3168,7 +3216,8 @@
       </refsect1>
       <refsect1>
         <title>See also</title>
-        <para><link linkend="gnumeric-function-HOUR"><function>HOUR</function></link>,
+        <para><link linkend="gnumeric-function-ODF.TIME"><function>ODF.TIME</function></link>,
+        <link linkend="gnumeric-function-HOUR"><function>HOUR</function></link>,
         <link linkend="gnumeric-function-MINUTE"><function>MINUTE</function></link>,
         <link linkend="gnumeric-function-SECOND"><function>SECOND</function></link>.
       </para>
@@ -5349,7 +5398,7 @@
           <function>DURATION</function>
         </refname>
         <refpurpose>
-        the duration of a security
+        the (Macaulay) duration of a security
       </refpurpose>
       </refnamediv>
       <refsynopsisdiv>
@@ -5366,7 +5415,7 @@
       </refsect1>
       <refsect1>
         <title>Description</title>
-        <para><function>DURATION</function> calculates the duration of a security.</para>
+        <para><function>DURATION</function> calculates the (Macaulay) duration of a security.</para>
       </refsect1>
       <refsect1>
         <title>Note</title>
@@ -5374,7 +5423,8 @@
       </refsect1>
       <refsect1>
         <title>See also</title>
-        <para><link linkend="gnumeric-function-MDURATION"><function>MDURATION</function></link>.
+        <para><link linkend="gnumeric-function-MDURATION"><function>MDURATION</function></link>,
+        <link linkend="gnumeric-function-G_DURATION"><function>G_DURATION</function></link>.
       </para>
       </refsect1>
     </refentry>
@@ -5589,7 +5639,9 @@
       <refsect1>
         <title>See also</title>
         <para><link linkend="gnumeric-function-FV"><function>FV</function></link>,
-        <link linkend="gnumeric-function-PV"><function>PV</function></link>.
+        <link linkend="gnumeric-function-PV"><function>PV</function></link>,
+        <link linkend="gnumeric-function-DURATION"><function>DURATION</function></link>,
+        <link linkend="gnumeric-function-MDURATION"><function>MDURATION</function></link>.
       </para>
       </refsect1>
     </refentry>
@@ -5753,7 +5805,7 @@
           <function>MDURATION</function>
         </refname>
         <refpurpose>
-        the Macaulay duration of a security
+        the modified (Macaulay) duration of a security
       </refpurpose>
       </refnamediv>
       <refsynopsisdiv>
@@ -5770,7 +5822,7 @@
       </refsect1>
       <refsect1>
         <title>Description</title>
-        <para><function>MDURATION</function> calculates the Macaulay duration of a security.</para>
+        <para><function>MDURATION</function> calculates the modified (Macaulay) duration of a security.</para>
       </refsect1>
       <refsect1>
         <title>Note</title>
@@ -5778,7 +5830,8 @@
       </refsect1>
       <refsect1>
         <title>See also</title>
-        <para><link linkend="gnumeric-function-DURATION"><function>DURATION</function></link>.
+        <para><link linkend="gnumeric-function-DURATION"><function>DURATION</function></link>,
+        <link linkend="gnumeric-function-G_DURATION"><function>G_DURATION</function></link>.
       </para>
       </refsect1>
     </refentry>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]