From 1bcafc58d13681d25f0576eabb33f9232dd373ae Mon Sep 17 00:00:00 2001 From: "Kevin M. Rosenberg" Date: Mon, 10 May 2004 20:39:10 +0000 Subject: [PATCH] r9307: documentation fixes --- doc/ref_aggregate.xml | 4 +++- doc/ref_object.xml | 16 ++++++++++------ 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/doc/ref_aggregate.xml b/doc/ref_aggregate.xml index 5e4cd66..09bbd74 100644 --- a/doc/ref_aggregate.xml +++ b/doc/ref_aggregate.xml @@ -209,13 +209,15 @@ structure. It's type is :pointer-self. Description - Accesses a slot value from a structure. + Accesses a slot value from a structure. This is generalized + and can be used with setf. Examples (get-slot-value foo-ptr 'foo-structure 'field-name) +(setf (get-slot-value foo-ptr 'foo-structure 'field-name) 10) diff --git a/doc/ref_object.xml b/doc/ref_object.xml index 6ee2efd..ed76892 100644 --- a/doc/ref_object.xml +++ b/doc/ref_object.xml @@ -667,6 +667,13 @@ if a cstring returned by a function is &null;. Arguments and Values + + binding-name + + A symbol which will be bound to the casted object. + + + ptr @@ -693,12 +700,9 @@ if a cstring returned by a function is &null;. Description - 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. -- 2.34.1