r1546: *** empty log message ***
[uffi.git] / doc / ref.sgml
index 33f8a568d7e317d990aade3ca42ee60cf8efaa09..aaf1feac499abe4fde3a6c841017de27e7a7328e 100644 (file)
        </para>
       </sect2>
 
-      <sect2 id="uffi-declare">
-       <title>uffi-declare</title>
-       <para>
-         This is used wherever a <function>declare</function>
-         expression can be placed. For example:
-       </para>
-       <para>
-         <programlisting>
-(let ((my-structure (uffi:allocate-foreign-object 'a-struct)))
-   (uffi:uffi-declare a-struct my-structure))
-         </programlisting>
-       </para>
-      </sect2>
-
-      <sect2 id="slot-type">
-       <title>slot-type</title>
+      <sect2 id="def-type">
+       <title>def-type</title>
        <para>
-         This is used inside of <function>defclass</function> and
-         <function>defstruct</function> expressions to set the type
-         for a field. Because the type identifier is not evaluated in
-         &cl;, the expression must be backquoted for effect. For
-         example:
-       </para>
+         This is used wherever a &cl; <function>deftype</function>
+         expression can be placed. Used to declare types to
+the compiler for optimization. Currently, on &cmucl; takes advantage
+of this.       </para>
        <para>
          <programlisting>
-(eval 
-  `(defclass a-class ()
-     ((char-ptr :type ,(uffi:slot-type (* :char))))))
+(uffi:def-type my-struct-def my-struct-foreign-type)
          </programlisting>
        </para>
       </sect2>