r1630: *** empty log message ***

[uffi.git] / doc / ref.sgml

diff --git a/doc/ref.sgml b/doc/ref.sgml
index 82ee66a5df717e7d9ed15cbbfa5e3d8d607c39f1..58ac773cac341a8ec6f7a275f640b487a902f1f6 100644 (file)
--- a/doc/ref.sgml
+++ b/doc/ref.sgml
@@ -868,7 +868,7 @@ can be freed.
       <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>
-         <function>allocate-foreign-object</function> <replaceable>type</replaceable> => <returnvalue>ptr</returnvalue>
+         <function>allocate-foreign-object</function> <replaceable>type &amp;optional size</replaceable> => <returnvalue>ptr</returnvalue>
        </synopsis>
       </refsynopsisdiv>
       <refsect1>
@@ -877,7 +877,15 @@ can be freed.
          <varlistentry>
            <term><parameter>type</parameter></term>
            <listitem>
-             <para>A type of foreign object to allocate.
+             <para>A unevaluated type of foreign object to allocate.
+             </para>
+           </listitem>
+         </varlistentry>
+         <varlistentry>
+           <term><parameter>size</parameter></term>
+           <listitem>
+             <para>An optional size parameter. If specified, allocates and returns an
+array of <parameter>type</parameter> that is <parameter>size</parameter> members long.
              </para>
            </listitem>
          </varlistentry>
@@ -1093,7 +1101,7 @@ can be freed.
     <refentry id="ensure-char-character">
       <refnamediv>
        <refname>ensure-char-character</refname>
-       <refpurpose>Ensures that a dereferenced :char pointer is
+       <refpurpose>Ensures that a dereferenced <constant>:char</constant> pointer is
 a character.
        </refpurpose>
        <refclass>Macro</refclass>
@@ -1161,7 +1169,7 @@ integer.</para>
     <refentry id="ensure-char-integer">
       <refnamediv>
        <refname>ensure-char-integer</refname>
-       <refpurpose>Ensures that a dereferenced :char pointer is
+       <refpurpose>Ensures that a dereferenced <constant>:char</constant> pointer is
 an integer.
        </refpurpose>
        <refclass>Macro</refclass>