changeset 564:1f4a17c1c56d

Several functions ready.
author roug
date Thu, 31 Oct 2002 22:05:32 +0000
parents e1be1b610076
children 0e84dcd81835
files docs/ccguide/atof.refentry
diffstat 1 files changed, 33 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/docs/ccguide/atof.refentry	Thu Oct 31 22:05:32 2002 +0000
+++ b/docs/ccguide/atof.refentry	Thu Oct 31 22:05:32 2002 +0000
@@ -1,14 +1,26 @@
 <refentry id="atof">
 <refnamediv>
-<refname>atof</refname>
-<refpurpose>Placeholder</refpurpose>
+<refname>Atof</refname>
+<refname>Atoi</refname>
+<refname>Atol</refname>
+<refpurpose>ASCII to number conversions</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
 <funcsynopsis>
 <funcprototype>
-  <funcdef><function>atof</function></funcdef>
-  <paramdef>type <parameter>arg1</parameter></paramdef>
+  <funcdef>double <function>atof</function></funcdef>
+  <paramdef>char *<parameter>ptr</parameter></paramdef>
+</funcprototype>
+
+<funcprototype>
+  <funcdef>long <function>atol</function></funcdef>
+  <paramdef>char *<parameter>ptr</parameter></paramdef>
+</funcprototype>
+
+<funcprototype>
+  <funcdef>int <function>atoi</function></funcdef>
+  <paramdef>char *<parameter>ptr</parameter></paramdef>
 </funcprototype>
 </funcsynopsis>
 
@@ -16,7 +28,23 @@
 
 <refsect1><title>Description</title>
 <para>
-Placeholder
+Conversions of the string pointed to by "ptr" to the relevant
+number type are carried out by these functions. They cease to
+convert a number when the first unrecognized character is
+encountered.
+</para>
+<para>
+Each skips leading spaces and tab characters. Atof()
+recognizes an optional sign followed by a digit string that
+could possibly contain a decimal point, then an optional "e"
+or "E", and optional sign and a digit string. Atol() and atoi()
+recognize an optional sign and a digit string.
+</para>
+</refsect1>
+<refsect1><title>Caveats</title>
+<para>
+Overflow causes unpredictable results. There are no error
+indications.
 </para>
 </refsect1>
 </refentry>