Changeset 13467 in project


Ignore:
Timestamp:
03/03/09 18:57:45 (11 years ago)
Author:
Kon Lovett
Message:

Doc update for box-location

File:
1 edited

Legend:

Unmodified
Added
Removed

  • wiki/eggref/4/box

    r13462 r13467  
    2323=== make-box
    2424
    25 <procedure>(make-box OBJECT [#:immutable #f]) => BOX</procedure>
     25<procedure>(make-box OBJECT [#:immutable? #f]) => BOX</procedure>
    2626
    2727Returns a {{BOX}} with initial value {{OBJECT}}.
    2828
    29 The {{BOX}} is mutable unless the {{immutable}} keyword argument is {{#t}}.
     29The {{BOX}} is mutable unless the {{immutable?}} keyword argument is {{#t}}.
    3030An attempt to mutate the boxed value will signal an exception.
    3131
    3232=== make-box-variable
    3333
    34 <procedure>(make-box-variable VARIABLE [#:immutable #f]) => BOX</procedure>
     34<procedure>(make-box-variable VARIABLE [#:immutable? #f]) => BOX</procedure>
    3535
    3636Returns a boxed reference to the {{VARIABLE}}, which must be in lexical-scope.
    3737
    38 The {{BOX}} is mutable unless the {{immutable}} keyword argument is {{#t}}.
     38The {{BOX}} is mutable unless the {{immutable?}} keyword argument is {{#t}}.
    3939
    4040=== make-box-location
    4141
    42 <procedure>(make-box-location TYPE INITIAL-VALUE [#:immutable #f]) => BOX</procedure>
     42<procedure>(make-box-location TYPE INITIAL-VALUE [#:immutable? #f]) => BOX</procedure>
    4343
    4444Returns a boxed reference to a location of {{TYPE}} and {{INITIAL-VALUE}}.
    4545
    46 The {{BOX}} is mutable unless the {{immutable}} keyword argument is {{#t}}.
     46The {{BOX}} is mutable unless the {{immutable?}} keyword argument is {{#t}}.
    4747
    4848Unavailable in EVALuated source.
    … …  
    9393=== box-location
    9494
    95 <procedure>(box-location BOX) => LOCATION</procedure>
     95<procedure>(box-location BOX [#:weak? #f]) => LOCATION</procedure>
    9696
    9797Returns a {{LOCATION}} object for a boxed variable, location or locatable box.
    9898Signals an exception otherwise.
     99
     100The locative is "strong" unless the {{weak?}} keyword argument is {{#t}}. The
     101{{weak?}} keyword argument is ignored for boxed variables and locations.
    99102
    100103The location of a boxed value or boxed location is the box. The location of a boxed
Note: See TracChangeset for help on using the changeset viewer.