[Boost-commit] svn:boost r56063 - trunk/libs/property_tree/doc

Subject: [Boost-commit] svn:boost r56063 - trunk/libs/property_tree/doc
From: sebastian.redl_at_[hidden]
Date: 2009-09-06 10:06:36

Author: cornedbee
Date: 2009-09-06 10:06:36 EDT (Sun, 06 Sep 2009)
New Revision: 56063
URL: http://svn.boost.org/trac/boost/changeset/56063

Log:
Some doc fixes.
Text files modified: 
   trunk/libs/property_tree/doc/container.qbk |     2 +-                                      
   trunk/libs/property_tree/doc/synopsis.qbk  |     6 +++---                                  
   trunk/libs/property_tree/doc/tutorial.qbk  |    40 ++++++++++++++++++++--------------------
   3 files changed, 24 insertions(+), 24 deletions(-)

Modified: trunk/libs/property_tree/doc/container.qbk
==============================================================================
--- trunk/libs/property_tree/doc/container.qbk	(original)
+++ trunk/libs/property_tree/doc/container.qbk	2009-09-06 10:06:36 EDT (Sun, 06 Sep 2009)
@@ -8,7 +8,7 @@
 
 It is very important to remember that the property sequence is *not* ordered by
 the key. It preserves the order of insertion. It closely resembles a std::list.
-Fast access to children is provided via a separate lookup structure. Do not
+Fast access to children by name is provided via a separate lookup structure. Do not
 attempt to use algorithms that expect an ordered sequence (like binary_search)
 on a node's children.
 

Modified: trunk/libs/property_tree/doc/synopsis.qbk
==============================================================================
--- trunk/libs/property_tree/doc/synopsis.qbk	(original)
+++ trunk/libs/property_tree/doc/synopsis.qbk	2009-09-06 10:06:36 EDT (Sun, 06 Sep 2009)
@@ -12,9 +12,9 @@
 [def __ptree_get_child__ [memberref boost::property_tree::basic_ptree::get_child get_child]]
 [def __ptree_put_child__ [memberref boost::property_tree::basic_ptree::put_child put_child]]
 [def __ptree_data__ [memberref boost::property_tree::basic_ptree::data data]]
-The central component of the library is __basic_ptree__ class template.
-Instances of this class are property trees. It is parametrized on character
-type and key comparison policy; __ptree__, __wptree__, __iptree__ and
+The central component of the library is the __basic_ptree__ class template.
+Instances of this class are property trees. It is parametrized on key and data
+type, and key comparison policy; __ptree__, __wptree__, __iptree__ and
 __wiptree__ are typedefs of __basic_ptree__ using predefined combinations of
 template parameters.  Property tree is basically a somewhat simplified standard
 container (the closest being std::list), plus a bunch of extra member

Modified: trunk/libs/property_tree/doc/tutorial.qbk
==============================================================================
--- trunk/libs/property_tree/doc/tutorial.qbk	(original)
+++ trunk/libs/property_tree/doc/tutorial.qbk	2009-09-06 10:06:36 EDT (Sun, 06 Sep 2009)
@@ -1,7 +1,7 @@
 [section:tutorial Five Minute Tutorial]
 This tutorial uses XML. Note that the library is not specifically bound to XML,
 and any other supported format (such as INI or JSON) could be used instead.
-XML was chosen because author thinks that wide range of people is familiar
+XML was chosen because the author thinks that  wide range of people is familiar
 with it.
 
 Suppose we are writing a logging system for some application, and need to read
@@ -45,31 +45,31 @@
         __ptree__ pt;
 
         // Load the XML file into the property tree. If reading fails
-		// (cannot open file, parse error), an exception is thrown.
+        // (cannot open file, parse error), an exception is thrown.
         __read_xml__(filename, pt);
 
         // Get the filename and store it in the m_file variable.
-		// Note that we construct the path to the value by separating
-		// the individual keys with dots. If dots appear in the keys,
-		// a path type with a different separator can be used.
-		// If debug.filename key is not found, exception is thrown.
+        // Note that we construct the path to the value by separating
+        // the individual keys with dots. If dots appear in the keys,
+        // a path type with a different separator can be used.
+        // If the debug.filename key is not found, an exception is thrown.
         m_file = pt.__ptree_get__<std::string>("debug.filename");
 
         // Get the debug level and store it in the m_level variable.
-		// This is another version of the get method: if the value is
-		// not found, the default value (specified by the second
+        // This is another version of the get method: if the value is
+        // not found, the default value (specified by the second
         // parameter) is returned instead. The type of the value
-		// extracted is determined by the type of the second parameter,
-		// so we can simply write get(...) instead of get<int>(...).
+        // extracted is determined by the type of the second parameter,
+        // so we can simply write get(...) instead of get<int>(...).
         m_level = pt.__ptree_get__("debug.level", 0);
 
         // Iterate over the debug.modules section and store all found
         // modules in the m_modules set. The get_child() function
-		// returns a reference to the child at the specified path; if
-		// there is no such child, it throws. Property tree iterators
-		// are models of BidirectionalIterator.
+        // returns a reference to the child at the specified path; if
+        // there is no such child, it throws. Property tree iterators
+        // are models of BidirectionalIterator.
         BOOST_FOREACH(__ptree__::__ptree_value_type__ &v,
-	            pt.__ptree_get_child__("debug.modules"))
+                pt.__ptree_get_child__("debug.modules"))
             m_modules.__ptree_insert__(v.second.data());
     }
 
@@ -89,12 +89,12 @@
       pt.__ptree_put__("debug.level", m_level);
    
       // Iterate over the modules in the set and put them in the
-	  // property tree. Note that the put function places the new
-	  // key at the end of the list of keys. This is fine most of
-	  // the time. If you want to place an item at some other place
-	  // (i.e. at the front or somewhere in the middle), this can
-	  // be achieved using a combination of the insert and put_own
-	  // functions.
+      // property tree. Note that the put function places the new
+      // key at the end of the list of keys. This is fine most of
+      // the time. If you want to place an item at some other place
+      // (i.e. at the front or somewhere in the middle), this can
+      // be achieved using a combination of the insert and put_own
+      // functions.
       BOOST_FOREACH(const std::string &name, m_modules)
          pt.__ptree_put__("debug.modules.module", name, true);