Update of /cvsroot/boost/boost/libs/property_map/doc
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv11086
Modified Files:
dynamic_property_map.rst
Log Message:
updated documentation.
Index: dynamic_property_map.rst
===================================================================
RCS file: /cvsroot/boost/boost/libs/property_map/doc/dynamic_property_map.rst,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- dynamic_property_map.rst 8 Feb 2005 16:43:58 -0000 1.1
+++ dynamic_property_map.rst 2 May 2007 20:49:29 -0000 1.2
@@ -268,13 +268,18 @@
bool put(const std::string& name, dynamic_properties& dp, const Key& key,
const Value& value)
-This function adds a key-value pair to the property map with the matching name
-and key type. If no matching property map is found and a generator function was
-supplied at construction, then that function is used to create a new
-property map; if the ``dynamic_properties`` object was
-default-constructed, then ``property_not_found`` is
-thrown. Furthermore, if the property map found does not support put,
-``dynamic_const_put_error`` is thrown.
+This function adds a key-value pair to the property map with the
+matching name and key type. If no matching property map is found,
+behavior depends on the availability of a property map generator. If
+a property map generator was supplied when the ``dynamic_properties``
+object was constructed, then that function is used to create a new
+property map. If the generator fails to generate a property map
+(returns a null ``auto_ptr``), then the ``put`` function returns
+``false``. If, on the other hand, the ``dynamic_properties`` object
+has no property map generator (meaning it was default-constructed),
+then ``property_not_found`` is thrown. If a candidate property map is
+found but it does not support ``put``, ``dynamic_const_put_error`` is
+thrown.
::
-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Boost-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/boost-cvs
