Initial support for external-formats for encoding foreign strings

[uffi.git] / doc / ref_object.xml

diff --git a/doc/ref_object.xml b/doc/ref_object.xml
index 893121977c95277d0fdfbedd3eecfe24a039ff7a..ed76892089168cf6c95f8d66003b8b605dce86c2 100644 (file)
--- a/doc/ref_object.xml
+++ b/doc/ref_object.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
-<!ENTITY % myents SYSTEM "entities.xml">
+<!ENTITY % myents SYSTEM "entities.inc">
 %myents;
 ]>
 
@@ -667,6 +667,13 @@ if a cstring returned by a function is &null;.
       <refsect1>
        <title>Arguments and Values</title>
        <variablelist>
+         <varlistentry>
+           <term><parameter>binding-name</parameter></term>
+           <listitem>
+             <para>A symbol which will be bound to the casted object.
+             </para>
+           </listitem>
+         </varlistentry>
          <varlistentry>
            <term><parameter>ptr</parameter></term>
            <listitem>
@@ -693,12 +700,9 @@ if a cstring returned by a function is &null;.
       <refsect1>
        <title>Description</title>
        <para>
-  Executes BODY with POINTER cast to be a pointer to type TYPE. If
-  BINDING-NAME is provided the cast pointer will be bound to this
-  name during the execution of BODY. If BINDING-NAME is not provided
-  POINTER must be a name bound to the pointer which should be
-  cast. This name will be bound to the cast pointer during the
-  execution of BODY.
+  Executes BODY with POINTER cast to be a pointer to type TYPE.
+  BINDING-NAME is will be bound to this value during the execution of
+  BODY.
 
   This is a no-op in AllegroCL but will wrap BODY in a LET form if
   BINDING-NAME is provided.