changeset 567:b3caab86dff9

Several functions ready.
author roug
date Thu, 31 Oct 2002 22:05:32 +0000
parents 3339ee2e58bc
children 23db189b6713
files docs/ccguide/l3tol.refentry
diffstat 1 files changed, 23 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/docs/ccguide/l3tol.refentry	Thu Oct 31 22:05:32 2002 +0000
+++ b/docs/ccguide/l3tol.refentry	Thu Oct 31 22:05:32 2002 +0000
@@ -1,14 +1,24 @@
 <refentry id="l3tol">
 <refnamediv>
-<refname>l3tol</refname>
-<refpurpose>Placeholder</refpurpose>
+<refname>L3tol</refname>
+<refname>Ltol3</refname>
+<refpurpose>convet between long integers and 3-byte integers</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>
 <funcsynopsis>
 <funcprototype>
   <funcdef><function>l3tol</function></funcdef>
-  <paramdef>type <parameter>arg1</parameter></paramdef>
+  <paramdef>long *<parameter>lp</parameter></paramdef>
+  <paramdef>char *<parameter>cp</parameter></paramdef>
+  <paramdef>int <parameter>n</parameter></paramdef>
+</funcprototype>
+
+<funcprototype>
+  <funcdef><function>ltol3</function></funcdef>
+  <paramdef>char *<parameter>cp</parameter></paramdef>
+  <paramdef>long *<parameter>lp</parameter></paramdef>
+  <paramdef>int <parameter>n</parameter></paramdef>
 </funcprototype>
 </funcsynopsis>
 
@@ -16,7 +26,16 @@
 
 <refsect1><title>Description</title>
 <para>
-Placeholder
+Certain system values, such as disc addresses, are maintained
+in three-byte form rather than four-byte; these functions
+enable arithmetic to be used on them.
+</para>
+<para>
+L3tol converts a vector on "n" three-byte integers pointed to
+by "cp", into a vector of long integers starting at "lp".
+</para>
+<para>
+Ltol3 does the opposite.
 </para>
 </refsect1>
 </refentry>