[Gd-chatter] r10943 - in trunk/documentation/topic: map/reference reference/lib/common-dylan/transcendentals
housel at gwydiondylan.org
housel at gwydiondylan.org
Tue Nov 7 06:55:31 CET 2006
Author: housel
Date: Tue Nov 7 06:55:26 2006
New Revision: 10943
Added:
trunk/documentation/topic/map/reference/transcendentals.ditamap (contents, props changed)
trunk/documentation/topic/map/reference/transcendentals.xml (contents, props changed)
Modified:
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/Ddouble_e.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/asin.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/atan.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/atan2.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/exp.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/isqrt.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/log.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/logn.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/sin.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/sinh.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/sqrt.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/tan.xml
trunk/documentation/topic/reference/lib/common-dylan/transcendentals/tanh.xml
Log:
Bug: 7249
Document the transcendentals module of the common-dylan library.
Added: trunk/documentation/topic/map/reference/transcendentals.ditamap
==============================================================================
--- (empty file)
+++ trunk/documentation/topic/map/reference/transcendentals.ditamap Tue Nov 7 06:55:26 2006
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "../dtd/map.dtd">
+<map title="The Transcendentals Module">
+ <topicref navtitle="Introduction" href="../../reference/lib/common-dylan/transcendentals.xml"/>
+ <topicref href="transcendentals.xml">
+ <topicref href="../../reference/lib/common-dylan/transcendentals/Ddouble_e.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/Ddouble_pi.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/Dsingle_e.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/Dsingle_pi.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/acos.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/acosh.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/asin.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/asinh.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/atan.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/atan2.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/atanh.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/cos.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/cosh.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/exp.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/isqrt.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/log.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/logn.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/sin.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/sinh.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/sqrt.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/tan.xml"/>
+ <topicref href="../../reference/lib/common-dylan/transcendentals/tanh.xml"/>
+ </topicref>
+</map>
Added: trunk/documentation/topic/map/reference/transcendentals.xml
==============================================================================
--- (empty file)
+++ trunk/documentation/topic/map/reference/transcendentals.xml Tue Nov 7 06:55:26 2006
@@ -0,0 +1,11 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "../dtd/topic.dtd" []>
+<topic id="transcendentals-module">
+ <title>The Transcendentals module</title>
+
+ <body>
+ <p>This section contains a reference entry for each item exported
+ from the <apiname>Common Extensions</apiname> library’s
+ <apiname>transcendentals</apiname> module.</p>
+ </body>
+</topic>
\ No newline at end of file
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/Ddouble_e.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/Ddouble_e.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/Ddouble_e.xml Tue Nov 7 06:55:26 2006
@@ -3,8 +3,8 @@
<dylanConstant id="lib-common-dylan-transcendentals-Ddouble_e">
<apiName>$double-e</apiName>
- <shortdesc>The value of <codeph>e</codeph> , the base of natural
- logarithms, as a double precision floating point number</shortdesc>
+ <shortdesc>The value of <codeph>e</codeph>, the base of natural
+ logarithms, as a double precision floating point number.</shortdesc>
<prolog>
<author></author>
@@ -20,7 +20,7 @@
</dylanConstantDef>
<apiDesc>
- <p>The value of <codeph>e</codeph> , the base of natural
+ <p>The value of <codeph>e</codeph>, the base of natural
logarithms, as a double precision floating point number.</p>
</apiDesc>
</dylanConstantDetail>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/asin.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/asin.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/asin.xml Tue Nov 7 06:55:26 2006
@@ -24,7 +24,7 @@
<dylanFunctionReturn>
<apiItemName>result</apiItemName>
<apiOperationClassifier href="../../dylan/dylan/LnumberG.xml"><number></apiOperationClassifier>
- <apiDefNote></apiDefNote>
+ <apiDefNote>The resulting angle in radians.</apiDefNote>
</dylanFunctionReturn>
</dylanGenericFunctionDef>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/atan.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/atan.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/atan.xml Tue Nov 7 06:55:26 2006
@@ -23,7 +23,7 @@
<dylanFunctionReturn>
<apiItemName>result</apiItemName>
<apiOperationClassifier href="../../dylan/dylan/LnumberG.xml"><number></apiOperationClassifier>
- <apiDefNote></apiDefNote>
+ <apiDefNote>The resulting angle in radians.</apiDefNote>
</dylanFunctionReturn>
</dylanGenericFunctionDef>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/atan2.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/atan2.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/atan2.xml Tue Nov 7 06:55:26 2006
@@ -30,7 +30,7 @@
<dylanFunctionReturn>
<apiItemName>result</apiItemName>
<apiOperationClassifier href="../../dylan/dylan/LnumberG.xml"><number></apiOperationClassifier>
- <apiDefNote></apiDefNote>
+ <apiDefNote>The resulting angle in radians.</apiDefNote>
</dylanFunctionReturn>
</dylanGenericFunctionDef>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/exp.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/exp.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/exp.xml Tue Nov 7 06:55:26 2006
@@ -2,7 +2,10 @@
<!DOCTYPE dylanGenericFunction PUBLIC "-//Gwydion//DTD DITA Dylan API Generic Function//EN" "../../../../dtd/dylanGenericFunction.dtd" []>
<dylanGenericFunction id="lib-common-dylan-transcendentals-exp">
<apiName>exp</apiName>
- <shortdesc>Returns .</shortdesc>
+
+ <shortdesc>Returns <codeph>e</codeph>, the base of natural
+ logarithms, raised to the power indicated by its
+ argument.</shortdesc>
<prolog>
<author></author>
@@ -28,7 +31,9 @@
</dylanGenericFunctionDef>
<apiDesc>
- <p></p>
+ <p>Returns <codeph>e</codeph>, the base of natural logarithms,
+ raised to the power <varname>x</varname>. The floating point
+ precision is given by the precision of <varname>x</varname>.</p>
</apiDesc>
</dylanGenericFunctionDetail>
</dylanGenericFunction>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/isqrt.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/isqrt.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/isqrt.xml Tue Nov 7 06:55:26 2006
@@ -2,7 +2,9 @@
<!DOCTYPE dylanFunction PUBLIC "-//Gwydion//DTD DITA Dylan API Function//EN" "../../../../dtd/dylanFunction.dtd" []>
<dylanFunction id="lib-common-dylan-transcendentals-isqrt">
<apiName>isqrt</apiName>
- <shortdesc>Returns .</shortdesc>
+
+ <shortdesc>Returns the integer square root of its
+ argument.</shortdesc>
<prolog>
<author></author>
@@ -27,7 +29,10 @@
</dylanFunctionDef>
<apiDesc>
- <p></p>
+ <p>Returns the integer square root of <varname>x</varname>, that
+ is the greatest integer less than or equal to the exact positive
+ square root of <varname>x</varname>. If <varname>x</varname> is
+ less than zero, an error is signalled.</p>
</apiDesc>
</dylanFunctionDetail>
</dylanFunction>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/log.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/log.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/log.xml Tue Nov 7 06:55:26 2006
@@ -2,7 +2,9 @@
<!DOCTYPE dylanGenericFunction PUBLIC "-//Gwydion//DTD DITA Dylan API Generic Function//EN" "../../../../dtd/dylanGenericFunction.dtd" []>
<dylanGenericFunction id="lib-common-dylan-transcendentals-log">
<apiName>log</apiName>
- <shortdesc>Returns .</shortdesc>
+
+ <shortdesc>Returns the natural logarithm of its
+ argument.</shortdesc>
<prolog>
<author></author>
@@ -28,7 +30,11 @@
</dylanGenericFunctionDef>
<apiDesc>
- <p></p>
+ <p>Returns the natural logarithm of <varname>x</varname>. If
+ <varname>x</varname> is less than or equal to zero, an error is
+ signalled. The floating point precision of the result is given
+ by the precision of <varname>x</varname>. The result is a
+ single-float if x is an integer.</p>
</apiDesc>
</dylanGenericFunctionDetail>
</dylanGenericFunction>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/logn.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/logn.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/logn.xml Tue Nov 7 06:55:26 2006
@@ -2,7 +2,9 @@
<!DOCTYPE dylanFunction PUBLIC "-//Gwydion//DTD DITA Dylan API Function//EN" "../../../../dtd/dylanFunction.dtd" []>
<dylanFunction id="lib-common-dylan-transcendentals-logn">
<apiName>logn</apiName>
- <shortdesc>Returns .</shortdesc>
+
+ <shortdesc>Returns the logarithm of its argument to the given
+ base.</shortdesc>
<prolog>
<author></author>
@@ -22,7 +24,7 @@
<dylanFunctionParam>
<apiItemName>base</apiItemName>
<apiOperationClassifier href="../../dylan/dylan/LnumberG.xml"><number></apiOperationClassifier>
- <apiDefNote></apiDefNote>
+ <apiDefNote>Must be strictly greater than 1.</apiDefNote>
</dylanFunctionParam>
<dylanFunctionReturn>
<apiItemName>result</apiItemName>
@@ -32,7 +34,13 @@
</dylanFunctionDef>
<apiDesc>
- <p></p>
+ <p>Returns the logarithm of <varname>x</varname> to the given
+ <varname>base</varname>. If <varname>x</varname> is less than or
+ equal to zero, an error is signalled. The floating point
+ precision of the result is given by the precision of
+ <varname>x</varname>. The result is a single-float if number is
+ an integer.</p>
+
</apiDesc>
</dylanFunctionDetail>
</dylanFunction>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/sin.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/sin.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/sin.xml Tue Nov 7 06:55:26 2006
@@ -2,7 +2,8 @@
<!DOCTYPE dylanGenericFunction PUBLIC "-//Gwydion//DTD DITA Dylan API Generic Function//EN" "../../../../dtd/dylanGenericFunction.dtd" []>
<dylanGenericFunction id="lib-common-dylan-transcendentals-sin">
<apiName>sin</apiName>
- <shortdesc>Returns .</shortdesc>
+
+ <shortdesc>Returns the sine of its argument.</shortdesc>
<prolog>
<author></author>
@@ -18,7 +19,7 @@
<dylanFunctionParam>
<apiItemName>x</apiItemName>
<apiOperationClassifier href="../../dylan/dylan/LnumberG.xml"><number></apiOperationClassifier>
- <apiDefNote></apiDefNote>
+ <apiDefNote>The input angle, in radians.</apiDefNote>
</dylanFunctionParam>
<dylanFunctionReturn>
<apiItemName>result</apiItemName>
@@ -28,7 +29,10 @@
</dylanGenericFunctionDef>
<apiDesc>
- <p></p>
+ <p>Returns the sine of its argument. The floating point
+ precision of the result is given by the precision of
+ <varname>x</varname>. The result is a single-float if
+ <varname>x</varname> is an integer.</p>
</apiDesc>
</dylanGenericFunctionDetail>
</dylanGenericFunction>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/sinh.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/sinh.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/sinh.xml Tue Nov 7 06:55:26 2006
@@ -2,7 +2,8 @@
<!DOCTYPE dylanGenericFunction PUBLIC "-//Gwydion//DTD DITA Dylan API Generic Function//EN" "../../../../dtd/dylanGenericFunction.dtd" []>
<dylanGenericFunction id="lib-common-dylan-transcendentals-sinh">
<apiName>sinh</apiName>
- <shortdesc>Returns .</shortdesc>
+
+ <shortdesc>Returns the hyperbolic sine of its argument.</shortdesc>
<prolog>
<author></author>
@@ -28,7 +29,10 @@
</dylanGenericFunctionDef>
<apiDesc>
- <p></p>
+ <p>Returns the hyperbolic sine of its argument. The floating
+ point precision of the result is given by the precision of
+ <varname>x</varname>. The result is a single-float if
+ <varname>x</varname> is an integer.</p>
</apiDesc>
</dylanGenericFunctionDetail>
</dylanGenericFunction>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/sqrt.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/sqrt.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/sqrt.xml Tue Nov 7 06:55:26 2006
@@ -2,7 +2,8 @@
<!DOCTYPE dylanGenericFunction PUBLIC "-//Gwydion//DTD DITA Dylan API Generic Function//EN" "../../../../dtd/dylanGenericFunction.dtd" []>
<dylanGenericFunction id="lib-common-dylan-transcendentals-sqrt">
<apiName>sqrt</apiName>
- <shortdesc>Returns .</shortdesc>
+
+ <shortdesc>Returns the square root of its argument.</shortdesc>
<prolog>
<author></author>
@@ -28,7 +29,11 @@
</dylanGenericFunctionDef>
<apiDesc>
- <p></p>
+ <p>Returns the square root of <varname>x</varname>. If
+ <varname>x</varname> is less than zero an error is signalled.
+ The floating point precision of the result is given by the
+ precision of <varname>x</varname>. The result is a single-float
+ if <varname>x</varname> is an integer.</p>
</apiDesc>
</dylanGenericFunctionDetail>
</dylanGenericFunction>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/tan.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/tan.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/tan.xml Tue Nov 7 06:55:26 2006
@@ -2,7 +2,8 @@
<!DOCTYPE dylanGenericFunction PUBLIC "-//Gwydion//DTD DITA Dylan API Generic Function//EN" "../../../../dtd/dylanGenericFunction.dtd" []>
<dylanGenericFunction id="lib-common-dylan-transcendentals-tan">
<apiName>tan</apiName>
- <shortdesc>Returns .</shortdesc>
+
+ <shortdesc>Returns the tangent of its argument.</shortdesc>
<prolog>
<author></author>
@@ -18,7 +19,7 @@
<dylanFunctionParam>
<apiItemName>x</apiItemName>
<apiOperationClassifier href="../../dylan/dylan/LnumberG.xml"><number></apiOperationClassifier>
- <apiDefNote></apiDefNote>
+ <apiDefNote>The input angle, in radians.</apiDefNote>
</dylanFunctionParam>
<dylanFunctionReturn>
<apiItemName>result</apiItemName>
@@ -28,7 +29,10 @@
</dylanGenericFunctionDef>
<apiDesc>
- <p></p>
+ <p>Returns the tangent of its argument. The floating point
+ precision of the result is given by the precision of
+ <varname>x</varname>. The result is a single-float if
+ <varname>x</varname> is an integer.</p>
</apiDesc>
</dylanGenericFunctionDetail>
</dylanGenericFunction>
Modified: trunk/documentation/topic/reference/lib/common-dylan/transcendentals/tanh.xml
==============================================================================
--- trunk/documentation/topic/reference/lib/common-dylan/transcendentals/tanh.xml (original)
+++ trunk/documentation/topic/reference/lib/common-dylan/transcendentals/tanh.xml Tue Nov 7 06:55:26 2006
@@ -2,7 +2,8 @@
<!DOCTYPE dylanGenericFunction PUBLIC "-//Gwydion//DTD DITA Dylan API Generic Function//EN" "../../../../dtd/dylanGenericFunction.dtd" []>
<dylanGenericFunction id="lib-common-dylan-transcendentals-tanh">
<apiName>tanh</apiName>
- <shortdesc>Returns .</shortdesc>
+
+ <shortdesc>Returns the hyperbolic tangent of its argument.</shortdesc>
<prolog>
<author></author>
@@ -28,7 +29,10 @@
</dylanGenericFunctionDef>
<apiDesc>
- <p></p>
+ <p>Returns the hyperbolic tangent of its argument. The floating
+ point precision of the result is given by the precision of
+ <varname>x</varname>. The result is a single-float if
+ <varname>x</varname> is an integer.</p>
</apiDesc>
</dylanGenericFunctionDetail>
</dylanGenericFunction>
More information about the chatter
mailing list