[Boost-commit] svn:boost r76958 - trunk/libs/property_map/doc

Subject: [Boost-commit] svn:boost r76958 - trunk/libs/property_map/doc
From: jewillco_at_[hidden]
Date: 2012-02-09 15:20:06

Author: jewillco
Date: 2012-02-09 15:20:05 EST (Thu, 09 Feb 2012)
New Revision: 76958
URL: http://svn.boost.org/trac/boost/changeset/76958

Log:
Added edited version of documentation patch in #6539; fixes #6539
Text files modified: 
   trunk/libs/property_map/doc/LvaluePropertyMap.html   |    14 +++++---------                          
   trunk/libs/property_map/doc/ReadablePropertyMap.html |     6 +++---                                  
   2 files changed, 8 insertions(+), 12 deletions(-)

Modified: trunk/libs/property_map/doc/LvaluePropertyMap.html
==============================================================================
--- trunk/libs/property_map/doc/LvaluePropertyMap.html	(original)
+++ trunk/libs/property_map/doc/LvaluePropertyMap.html	2012-02-09 15:20:05 EST (Thu, 09 Feb 2012)
@@ -19,13 +19,9 @@
 LvaluePropertyMap
 </H2>
 
-The LvaluePropertyMap provides an interface for accessing a
-reference to a property object (instead of a copy of the object as in
-the <TT>get()</TT> function required by <a
-href="./ReadablePropertyMap.html">ReadablePropertyMap</a>). An
-LvaluePropertyMap can be <I>mutable</I> or
-<I>non-mutable</I>. The mutable LvaluePropertyMap returns a
-reference whereas the non-mutable returns a const reference.
+The LvaluePropertyMap provides <code>operator[]</code> and function <code>get()</code> for accessing a
+reference to a value object. The return type  refines that of function <code>get()</code>in <a
+href="./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).
 
 <H3>Refinement of</H3>
 
@@ -60,7 +56,7 @@
 <td><TT>boost::property_traits&lt;PMap&gt;::reference</TT></td> 
 <td>
 The reference type, which must be a reference or const reference to
-the value typeof the property map.
+the value type of the property map.
 </td>
 </tr>
 
@@ -90,7 +86,7 @@
 <TT>value_type&amp;</TT> for mutable, <TT>const value_type&amp;</TT>
 otherwise.
 </TD>
-<TD>Obtain a reference to the property identified by <TT>key</TT>.</TD>
+<TD>Obtain a reference to the value associated with <TT>key</TT>.</TD>
 </TR>
 </TABLE>
 

Modified: trunk/libs/property_map/doc/ReadablePropertyMap.html
==============================================================================
--- trunk/libs/property_map/doc/ReadablePropertyMap.html	(original)
+++ trunk/libs/property_map/doc/ReadablePropertyMap.html	2012-02-09 15:20:05 EST (Thu, 09 Feb 2012)
@@ -20,8 +20,8 @@
 Readable Property Map
 </H2>
 
-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.
-The <tt>get()</tt> function returns a copy of the value object.
+A Readable Property Map provides read-access to the value  associated with a given key via a call to the <tt>get()</tt> function.
+The return type of the <tt>get()</tt>function   is either the <tt>value_type</tt> of the property map or a (const or non-const) reference to that type.
 
 <h3>Refinement of</h3>
 
@@ -95,7 +95,7 @@
 <td>Get Property Value </td>
 <TD><TT>get(pmap, key)</TT></TD>
 <TD><TT>reference</TT></TD>
-<TD>Lookup the property of the object identified by <TT>key</TT>.</TD>
+<TD>Lookup the value associated with <TT>key</TT>.</TD>
 </TR>
 
 </TABLE>