Ticket #6539: return_value_get.patch

File return_value_get.patch, 2.5 KB (added by anonymous, 11 years ago)

patch to concept documentation

  • LvaluePropertyMap.html

     
    1919LvaluePropertyMap
    2020</H2>
    2121
    22 The LvaluePropertyMap provides an interface for accessing a
    23 reference to a property object (instead of a copy of the object as in
    24 the <TT>get()</TT> function required by <a
    25 href="./ReadablePropertyMap.html">ReadablePropertyMap</a>). An
    26 LvaluePropertyMap can be <I>mutable</I> or
    27 <I>non-mutable</I>. The mutable LvaluePropertyMap returns a
    28 reference whereas the non-mutable returns a const reference.
     22The LvaluePropertyMap provides <code>operator[]</code> and function <code>get()</code> for accessing a
     23reference to a value object. The return type  refines that of function <code>get()</code>in <a
     24href="./ReadablePropertyMap.html">ReadablePropertyMap</a>; it can only be a reference (for a <I>mutable</I> LvaluePropertyMap) or a const reference (for a <I>non-mutable</I> LvaluePropertyMap).
    2925
    3026<H3>Refinement of</H3>
    3127
     
    6056<td><TT>boost::property_traits&lt;PMap&gt;::reference</TT></td>
    6157<td>
    6258The reference type, which must be a reference or const reference to
    63 the value typeof the property map.
     59the value type of the property map.
    6460</td>
    6561</tr>
    6662
     
    9086<TT>value_type&amp;</TT> for mutable, <TT>const value_type&amp;</TT>
    9187otherwise.
    9288</TD>
    93 <TD>Obtain a reference to the property identified by <TT>key</TT>.</TD>
     89<TD>Obtain a reference to the value associated with <TT>key</TT>.</TD>
    9490</TR>
    9591</TABLE>
    9692
  • ReadablePropertyMap.html

     
    2020Readable Property Map
    2121</H2>
    2222
    23 A Readable Property Map provides read-access to the value object associated with a given key via a call to the <tt>get()</tt> function.
    24 The <tt>get()</tt> function returns a copy of the value object.
     23A Readable Property Map provides read-access to the value associated with a given key via a call to the <tt>get()</tt> function.
     24The return type of the <tt>get()</tt>function   is convertible to a value object.
    2525
    2626<h3>Refinement of</h3>
    2727
     
    9595<td>Get Property Value </td>
    9696<TD><TT>get(pmap, key)</TT></TD>
    9797<TD><TT>reference</TT></TD>
    98 <TD>Lookup the property of the object identified by <TT>key</TT>.</TD>
     98<TD>Lookup the value associated with <TT>key</TT>.</TD>
    9999</TR>
    100100
    101101</TABLE>