r9307: documentation fixes
authorKevin M. Rosenberg <kevin@rosenberg.net>
Mon, 10 May 2004 20:39:10 +0000 (20:39 +0000)
committerKevin M. Rosenberg <kevin@rosenberg.net>
Mon, 10 May 2004 20:39:10 +0000 (20:39 +0000)
doc/ref_aggregate.xml
doc/ref_object.xml

index 5e4cd660a0f965935f9c69bb05f50f694e863b4a..09bbd741b1d451a93a42ebe769576a66a481d74e 100644 (file)
@@ -209,13 +209,15 @@ structure. It's type is <constant>:pointer-self</constant>.
       <refsect1>
        <title>Description</title>
        <para>
-         Accesses a slot value from a structure.
+         Accesses a slot value from a structure. This is generalized
+         and can be used with <function>setf</function>.
        </para>
       </refsect1>
       <refsect1>
        <title>Examples</title>
        <screen>
 (get-slot-value foo-ptr 'foo-structure 'field-name)
+(setf (get-slot-value foo-ptr 'foo-structure 'field-name) 10)
        </screen>
       </refsect1>
       <refsect1>
index 6ee2efd4925dce87f58f7a80d080832a55e50e81..ed76892089168cf6c95f8d66003b8b605dce86c2 100644 (file)
@@ -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.