r8115: formatting changes

diff --git a/doc/intro.xml b/doc/intro.xml
index 104e0d33f8c98504766f2321d882f81c9bf30f66..be722e84f3603f8f4cdd525dadbd505e85acf68c 100644 (file)
--- a/doc/intro.xml
+++ b/doc/intro.xml
@@ -14,7 +14,7 @@
       interface from Common Lisp to C-language compatible libraries.
     </para>
   </sect1>
-
+  
   <sect1>
     <title>Background
     </title>

diff --git a/doc/ref_declare.xml b/doc/ref_declare.xml
index 756ed870e481660fd44d4f15f8c83526aa23aa9d..5352722ea45584b0d90e18eb0c34d61597ee0e73 100644 (file)
--- a/doc/ref_declare.xml
+++ b/doc/ref_declare.xml
@@ -7,7 +7,7 @@
   
 <reference id="ref_declarations">
   <title>Declarations</title>
-
+  
   <partintro>
     <sect1>
       <title>Overview</title>
@@ -19,64 +19,64 @@
     </sect1>
   </partintro>
 
-      <refentry id="def-type">
-       <refnamediv>
-         <refname>def-type</refname>
-       <refpurpose>Defines a Common Lisp type. 
-       </refpurpose>
-       <refclass>Macro</refclass>
-      </refnamediv>
-      <refsynopsisdiv>
-       <title>Syntax</title>
-       <synopsis>
-         <function>def-type</function> <replaceable>name type</replaceable>
-       </synopsis>
-      </refsynopsisdiv>
-      <refsect1>
-       <title>Arguments and Values</title>
-       <variablelist>
-         <varlistentry>
-           <term><parameter>name</parameter></term>
-           <listitem>
-             <para>A symbol naming the type</para>
-           </listitem>
-         </varlistentry>
-         <varlistentry>
-           <term><parameter>type</parameter></term>
-           <listitem>
-             <para>A form that is evaluated that specifies the &uffi; type.
-             </para>
-           </listitem>
-         </varlistentry>
-       </variablelist>
-      </refsect1>
-      <refsect1>
-       <title>Description</title>
-       <para>Defines a Common Lisp type based on a &uffi; type.
-       </para>
-      </refsect1>
-      <refsect1>
-       <title>Examples</title>
-       <programlisting>
+  <refentry id="def-type">
+    <refnamediv>
+      <refname>def-type</refname>
+      <refpurpose>Defines a Common Lisp type. 
+      </refpurpose>
+      <refclass>Macro</refclass>
+    </refnamediv>
+    <refsynopsisdiv>
+      <title>Syntax</title>
+      <synopsis>
+       <function>def-type</function> <replaceable>name type</replaceable>
+      </synopsis>
+    </refsynopsisdiv>
+    <refsect1>
+      <title>Arguments and Values</title>
+      <variablelist>
+       <varlistentry>
+         <term><parameter>name</parameter></term>
+         <listitem>
+           <para>A symbol naming the type</para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term><parameter>type</parameter></term>
+         <listitem>
+           <para>A form that is evaluated that specifies the &uffi; type.
+           </para>
+         </listitem>
+       </varlistentry>
+      </variablelist>
+    </refsect1>
+    <refsect1>
+      <title>Description</title>
+      <para>Defines a Common Lisp type based on a &uffi; type.
+      </para>
+    </refsect1>
+    <refsect1>
+      <title>Examples</title>
+      <programlisting>
 (def-type char-ptr '(* :char))
 ...
 (defun foo (ptr)
-  (declare (type char-ptr ptr))
-  ...
-       </programlisting>
-      </refsect1>
-      <refsect1>
-       <title>Side Effects</title>
-       <para>Defines a new &cl; type.</para>
-      </refsect1>
-      <refsect1>
-       <title>Affected by</title>
-       <para>None.</para>
-      </refsect1>
-      <refsect1>
-       <title>Exceptional Situations</title>
-       <para>None.</para>
-      </refsect1>
-    </refentry>
-  </reference>
+(declare (type char-ptr ptr))
+...
+      </programlisting>
+    </refsect1>
+    <refsect1>
+      <title>Side Effects</title>
+      <para>Defines a new &cl; type.</para>
+    </refsect1>
+    <refsect1>
+      <title>Affected by</title>
+      <para>None.</para>
+    </refsect1>
+    <refsect1>
+      <title>Exceptional Situations</title>
+      <para>None.</para>
+    </refsect1>
+  </refentry>
+</reference>
 

diff --git a/doc/ref_primitive.xml b/doc/ref_primitive.xml
index 2f4395529d03249d69a19a2d6bec6d5c642b1d0f..ca9d77e306d0698da4e80205cc7fdcba73150ebf 100644 (file)
--- a/doc/ref_primitive.xml
+++ b/doc/ref_primitive.xml
@@ -6,267 +6,274 @@
 ]>
 
 <reference id="primitives">
-   <title>Primitive Types</title>
-          <partintro>
-         <title>Overview</title>
-       <para>
-         Primitive types have a single value, these include
-         characters, numbers, and pointers. They are all symbols in
-         the keyword package.
+  <title>Primitive Types</title>
+  <partintro>
+    <title>Overview</title>
+    <para>
+      Primitive types have a single value, these include
+      characters, numbers, and pointers. They are all symbols in
+      the keyword package.
+    </para>
+    <itemizedlist>
+      <listitem>
+       <para><constant>:char</constant> - Signed 8-bits. A
+         dereferenced :char pointer returns an character.
        </para>
-       <itemizedlist>
-         <listitem>
-           <para><constant>:char</constant> - Signed 8-bits. A
-dereferenced :char pointer returns an character.</para>
-         </listitem>
-         <listitem>
-           <para><constant>:unsigned-char</constant> - Unsigned 8-bits. A dereferenced :unsigned-char
-pointer returns an character.</para>
-         </listitem>
-         <listitem>
-           <para><constant>:byte</constant> - Signed 8-bits. A
-dereferenced :byte pointer returns an integer.</para>
-          </listitem>
-         <listitem>
-           <para><constant>:unsigned-byte</constant> - Unsigned 8-bits. A
-dereferenced :unsigned-byte pointer returns an integer.</para>
-         </listitem>
-         <listitem>
-           <para><constant>:short</constant> - Signed 16-bits.</para>
-         </listitem>
-         <listitem>
-           <para><constant>:unsigned-short</constant> - Unsigned 16-bits.</para>
-         </listitem>
-         <listitem>
-           <para><constant>:int</constant> - Signed 32-bits.</para>
-         </listitem>
-         <listitem>
-           <para><constant>:unsigned-int</constant> - Unsigned 32-bits.</para>
-         </listitem>
-         <listitem>
-           <para><constant>:long</constant> - Signed 32 or 64 bits, depending upon the platform.</para>
-         </listitem>
+      </listitem>
+      <listitem>
+       <para><constant>:unsigned-char</constant> - Unsigned 8-bits. A dereferenced :unsigned-char
+         pointer returns an character.
+       </para>
+      </listitem>
+      <listitem>
+       <para><constant>:byte</constant> - Signed 8-bits. A
+         dereferenced :byte pointer returns an integer.
+       </para>
+      </listitem>
+      <listitem>
+       <para><constant>:unsigned-byte</constant> - Unsigned 8-bits. A
+         dereferenced :unsigned-byte pointer returns an integer.
+       </para>
+      </listitem>
+      <listitem>
+       <para><constant>:short</constant> - Signed 16-bits.
+       </para>
+      </listitem>
+      <listitem>
+       <para><constant>:unsigned-short</constant> - Unsigned 16-bits.
+       </para>
+      </listitem>
+      <listitem>
+       <para><constant>:int</constant> - Signed 32-bits.</para>
+      </listitem>
+      <listitem>
+       <para><constant>:unsigned-int</constant> - Unsigned 32-bits.</para>
+      </listitem>
+      <listitem>
+       <para><constant>:long</constant> - Signed 32 or 64 bits, depending upon the platform.</para>
+      </listitem>
+      <listitem>
+       <para><constant>:unsigned-long</constant> - Unsigned 32 or 64 bits, depending upon the platform.</para>
+      </listitem>
+      <listitem>
+       <para><constant>:float</constant> - 32-bit floating point.</para>
+      </listitem>
+      <listitem>
+       <para><constant>:double</constant> - 64-bit floating point.</para>
+      </listitem>
+      <listitem>
+       <para><constant>:cstring</constant> - 
+         A &null; terminated string used for passing and returning characters strings with a &c; function.
+       </para>
+      </listitem>
+      <listitem>
+       <para><constant>:void</constant> - 
+         The absence of a value. Used to indicate that a function does not return a value.
+       </para>
+      </listitem>
+      <listitem>
+       <para><constant>:pointer-void</constant> - Points to a generic object.</para>
+      </listitem>
+      <listitem>
+       <para><constant>*</constant> - Used to declare a pointer to an object</para>
+      </listitem>
+    </itemizedlist>
+  </partintro>
+  
+  <refentry id="def-constant">
+    <refnamediv>
+      <refname>def-constant</refname>
+      <refpurpose>Binds a symbol to a constant. 
+      </refpurpose>
+      <refclass>Macro</refclass>
+    </refnamediv>
+    <refsynopsisdiv>
+      <title>Syntax</title>
+      <synopsis>
+       <function>def-constant</function> <replaceable>name value &amp;key export</replaceable>
+      </synopsis>
+    </refsynopsisdiv>
+    <refsect1>
+      <title>Arguments and Values</title>
+      <variablelist>
+       <varlistentry>
+         <term><parameter>name</parameter></term>
          <listitem>
-           <para><constant>:unsigned-long</constant> - Unsigned 32 or 64 bits, depending upon the platform.</para>
+           <para>A symbol that will be bound to the value.
+           </para>
          </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term><parameter>value</parameter></term>
          <listitem>
-           <para><constant>:float</constant> - 32-bit floating point.</para>
+           <para>An evaluated form that is bound the the name.
+           </para>
          </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term><parameter>export</parameter></term>
          <listitem>
-           <para><constant>:double</constant> - 64-bit floating point.</para>
+           <para>When &t;, the name is exported from the current package. The default is &nil;</para>
          </listitem>
+       </varlistentry>
+      </variablelist>
+    </refsect1>
+    <refsect1>
+      <title>Description</title>
+      <para>This is a thin wrapper around <function>defconstant</function>. It evaluates at
+       compile-time and optionally exports the symbol from the package.
+      </para>
+    </refsect1>
+    <refsect1>
+      <title>Examples</title>
+      <programlisting>
+(def-constant pi2 (* 2 pi))
+(def-constant exported-pi2 (* 2 pi) :export t)
+      </programlisting>
+    </refsect1>
+    <refsect1>
+      <title>Side Effects</title>
+      <para>Creates a new special variable..</para>
+    </refsect1>
+    <refsect1>
+      <title>Affected by</title>
+      <para>None.</para>
+    </refsect1>
+    <refsect1>
+      <title>Exceptional Situations</title>
+      <para>None.</para>
+    </refsect1>
+  </refentry>
+  
+  <refentry id="def-foreign-type">
+    <refnamediv>
+      <refname>def-foreign-type</refname>
+      <refpurpose>Defines a new foreign type. 
+      </refpurpose>
+      <refclass>Macro</refclass>
+    </refnamediv>
+    <refsect1>
+      <title>Syntax</title>
+      <synopsis>
+       <function>def-foreign-type</function> <replaceable>name type</replaceable>
+      </synopsis>
+    </refsect1>
+    <refsect1>
+      <title>Arguments and Values</title>
+      <variablelist>
+       <varlistentry>
+         <term><parameter>name</parameter></term>
          <listitem>
-           <para><constant>:cstring</constant> - 
-A &null; terminated string used for passing and returning characters strings with a &c; function.
+           <para>A symbol naming the new foreign type.
            </para>
          </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term><parameter>value</parameter></term>
          <listitem>
-           <para><constant>:void</constant> - 
-The absence of a value. Used to indicate that a function does not return a value.</para>
+           <para>A form that is not evaluated that defines the new
+             foreign type.
+           </para>
          </listitem>
+       </varlistentry>
+      </variablelist>
+    </refsect1>
+    <refsect1>
+      <title>Description</title>
+      <para>Defines a new foreign type.
+      </para>
+    </refsect1>
+    <refsect1>
+      <title>Examples</title>
+      <programlisting>
+(def-foreign-type my-generic-pointer :pointer-void)
+(def-foreign-type a-double-float :double-float)
+(def-foreign-type char-ptr (* :char))
+      </programlisting>
+    </refsect1>
+    <refsect1>
+      <title>Side Effects</title>
+      <para>Defines a new foreign type.
+      </para>
+    </refsect1>
+    <refsect1>
+      <title>Affected by</title>
+      <para>None.</para>
+    </refsect1>
+    <refsect1>
+      <title>Exceptional Situations</title>
+      <para>None.</para>
+    </refsect1>
+  </refentry>
+  
+  <refentry id="null-char-p">
+    <refnamediv>
+      <refname>null-char-p</refname>
+      <refpurpose>Tests a character for &null; value.
+      </refpurpose>
+      <refclass>Macro</refclass>
+    </refnamediv>
+    <refsect1>
+      <title>Syntax</title>
+      <synopsis>
+       <function>null-char-p</function> <replaceable>char</replaceable> => <returnvalue>is-null</returnvalue>
+      </synopsis>
+    </refsect1>
+    <refsect1>
+      <title>Arguments and Values</title>
+      <variablelist>
+       <varlistentry>
+         <term><parameter>char</parameter></term>
          <listitem>
-           <para><constant>:pointer-void</constant> - 
-Points to a generic object.</para>
+           <para>A character or integer.
+           </para>
          </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term><parameter>is-null</parameter></term>
          <listitem>
-           <para><constant>*</constant> - Used to declare a pointer to an object</para>
+           <para>A boolean flag indicating if char is a &null; value.
+           </para>
          </listitem>
-       </itemizedlist>
-      </partintro>
-
-      <refentry id="def-constant">
-       <refnamediv>
-         <refname>def-constant</refname>
-       <refpurpose>Binds a symbol to a constant. 
-       </refpurpose>
-       <refclass>Macro</refclass>
-      </refnamediv>
-      <refsynopsisdiv>
-       <title>Syntax</title>
-       <synopsis>
-         <function>def-constant</function> <replaceable>name value &amp;key export</replaceable>
-       </synopsis>
-      </refsynopsisdiv>
-      <refsect1>
-       <title>Arguments and Values</title>
-       <variablelist>
-         <varlistentry>
-           <term><parameter>name</parameter></term>
-           <listitem>
-             <para>A symbol that will be bound to the value.
-             </para>
-           </listitem>
-         </varlistentry>
-         <varlistentry>
-           <term><parameter>value</parameter></term>
-           <listitem>
-             <para>An evaluated form that is bound the the name.
-             </para>
-           </listitem>
-         </varlistentry>
-         <varlistentry>
-           <term><parameter>export</parameter></term>
-           <listitem>
-             <para>When &t;, the name is exported from the current package. The default is &nil;</para>
-           </listitem>
-         </varlistentry>
-       </variablelist>
-      </refsect1>
-      <refsect1>
-       <title>Description</title>
-       <para>
-         This is a thin wrapper around
-         <function>defconstant</function>. It evaluates at
-           compile-time and optionally exports the symbol from the package.
-       </para>
-      </refsect1>
-      <refsect1>
-       <title>Examples</title>
-       <programlisting>
-(def-constant pi2 (* 2 pi))
-(def-constant exported-pi2 (* 2 pi) :export t)
-       </programlisting>
-      </refsect1>
-      <refsect1>
-       <title>Side Effects</title>
-       <para>Creates a new special variable..</para>
-      </refsect1>
-      <refsect1>
-       <title>Affected by</title>
-       <para>None.</para>
-      </refsect1>
-      <refsect1>
-       <title>Exceptional Situations</title>
-       <para>None.</para>
-      </refsect1>
-    </refentry>
-
-    <refentry id="def-foreign-type">
-       <refnamediv>
-         <refname>def-foreign-type</refname>
-       <refpurpose>Defines a new foreign type. 
-       </refpurpose>
-       <refclass>Macro</refclass>
-      </refnamediv>
-      <refsect1>
-       <title>Syntax</title>
-<synopsis>
-         <function>def-foreign-type</function> <replaceable>name type</replaceable>
-</synopsis>
-      </refsect1>
-      <refsect1>
-       <title>Arguments and Values</title>
-       <variablelist>
-         <varlistentry>
-           <term><parameter>name</parameter></term>
-           <listitem>
-             <para>A symbol naming the new foreign type.
-             </para>
-           </listitem>
-         </varlistentry>
-         <varlistentry>
-           <term><parameter>value</parameter></term>
-           <listitem>
-             <para>A form that is not evaluated that defines the new
-foreign type.
-             </para>
-           </listitem>
-         </varlistentry>
-       </variablelist>
-      </refsect1>
-      <refsect1>
-       <title>Description</title>
-       <para>Defines a new foreign type.
-       </para>
-      </refsect1>
-      <refsect1>
-       <title>Examples</title>
-       <programlisting>
-(def-foreign-type my-generic-pointer :pointer-void)
-(def-foreign-type a-double-float :double-float)
-(def-foreign-type char-ptr (* :char))
-       </programlisting>
-      </refsect1>
-      <refsect1>
-       <title>Side Effects</title>
-       <para>Defines a new foreign type.
-       </para>
-      </refsect1>
-      <refsect1>
-       <title>Affected by</title>
-       <para>None.</para>
-      </refsect1>
-      <refsect1>
-       <title>Exceptional Situations</title>
-       <para>None.</para>
-      </refsect1>
-    </refentry>
-
-    <refentry id="null-char-p">
-       <refnamediv>
-         <refname>null-char-p</refname>
-       <refpurpose>Tests a character for &null; value.
-       </refpurpose>
-       <refclass>Macro</refclass>
-      </refnamediv>
-      <refsect1>
-       <title>Syntax</title>
-<synopsis>
-         <function>null-char-p</function> <replaceable>char</replaceable> => <returnvalue>is-null</returnvalue>
-</synopsis>
-      </refsect1>
-      <refsect1>
-       <title>Arguments and Values</title>
-       <variablelist>
-         <varlistentry>
-           <term><parameter>char</parameter></term>
-           <listitem>
-             <para>A character or integer.
-             </para>
-           </listitem>
-         </varlistentry>
-         <varlistentry>
-           <term><parameter>is-null</parameter></term>
-           <listitem>
-             <para>A boolean flag indicating if char is a &null; value.
-             </para>
-           </listitem>
-         </varlistentry>
-       </variablelist>
-      </refsect1>
-      <refsect1>
-       <title>Description</title>
-       <para>
-         A predicate testing if a character or integer is &null;. This
-abstracts the difference in implementations where some return a 
-<computeroutput>character</computeroutput> and some return a 
-<computeroutput>integer</computeroutput> whence dereferencing a 
-<computeroutput>C</computeroutput> character pointer.
-       </para>
-      </refsect1>
-      <refsect1>
-       <title>Examples</title>
-       <programlisting>
+       </varlistentry>
+      </variablelist>
+    </refsect1>
+    <refsect1>
+      <title>Description</title>
+      <para>
+       A predicate testing if a character or integer is &null;. This
+       abstracts the difference in implementations where some return a 
+       <computeroutput>character</computeroutput>
+       and some return a 
+       <computeroutput>integer</computeroutput>
+       whence dereferencing a 
+       <computeroutput>C</computeroutput>
+       character pointer.
+      </para>
+    </refsect1>
+    <refsect1>
+      <title>Examples</title>
+      <programlisting>
 (def-array-pointer ca :unsigned-char)
 (let ((fs (convert-to-foreign-string "ab")))
-   (values (null-char-p (deref-array fs 'ca 0))
-           (null-char-p (deref-array fs 'ca 2))))
+      (values (null-char-p (deref-array fs 'ca 0))
+      (null-char-p (deref-array fs 'ca 2))))
 => &nil;
    &t;
-       </programlisting>
-      </refsect1>
-      <refsect1>
-       <title>Side Effects</title>
-       <para>None.
-       </para>
-      </refsect1>
-      <refsect1>
-       <title>Affected by</title>
-       <para>None.</para>
-      </refsect1>
-      <refsect1>
-       <title>Exceptional Situations</title>
-       <para>None.</para>
-      </refsect1>
-    </refentry>
-  </reference>
+      </programlisting>
+    </refsect1>
+    <refsect1>
+      <title>Side Effects</title>
+      <para>None.
+      </para>
+    </refsect1>
+    <refsect1>
+      <title>Affected by</title>
+      <para>None.</para>
+    </refsect1>
+    <refsect1>
+      <title>Exceptional Situations</title>
+      <para>None.</para>
+    </refsect1>
+  </refentry>
+</reference>