r8112: convert from entities chapters to xinclude

[uffi.git] / doc / ref_declare.xml

diff --git a/doc/ref_declare.xml b/doc/ref_declare.xml
new file mode 100644 (file)
index 0000000..49b6c7b
--- /dev/null
+++ b/doc/ref_declare.xml
@@ -0,0 +1,82 @@
+<?xml version='1.0' ?>   <!-- Mode: Docbook --> 
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+               "file:///usr/share/sgml/docbook/dtd/xml/4.2/docbookx.dtd" [
+<!ENTITY % myents SYSTEM "entities.xml">
+%myents;
+]>
+  
+<reference id="ref_declarations">
+  <title>Declarations</title>
+
+  <partintro>
+    <sect1>
+      <title>Overview</title>
+      <para>Declarations are used to give the compiler optimizing
+       information about foreign types. Currently, only &cmucl;
+       supports declarations. On &acl; and &lw;, these expressions 
+       declare the type generically as &t;
+      </para>
+    </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>
+(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>
+