Re: [Boost-bugs] [Boost C++ Libraries] #3925: Property tree documentation is seriously out of date

Subject: Re: [Boost-bugs] [Boost C++ Libraries] #3925: Property tree documentation is seriously out of date
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2011-07-11 05:37:00

#3925: Property tree documentation is seriously out of date
---------------------------+------------------------------------------------
  Reporter:  anonymous     |       Owner:  cornedbee    
      Type:  Tasks         |      Status:  new          
 Milestone:  Boost 1.43.0  |   Component:  property_tree
   Version:  Boost 1.42.0  |    Severity:  Cosmetic     
Resolution:                |    Keywords:               
---------------------------+------------------------------------------------

Comment (by anonymous):

 In:
 http://www.boost.org/doc/libs/1_46_1/libs/property_tree/examples/debug_settings.cpp


 This probably shouldn't be a comment. It works works fine on the example
 input, and if it throws an exception there is a comment above explaining
 why.

 {{{
     //BOOST_FOREACH(ptree::value_type &v, pt.get_child("debug.modules"))
     //    m_modules.insert(v.second.data());
 }}}

 In:
 http://www.boost.org/doc/libs/1_46_1/doc/html/boost/property_tree/basic_ptree.html


 The documentation for
 {{{
 template<typename Type>
   self_type & add(const path_type & path, const Type & value);
 }}}
 says '''Set the newly created node's value to the given paremeter,
 translated with the supplied translator''', but there is no translator
 argument. Replace with '''translated using the default translator''' or
 '''translated to the tree's data type''' or something like that. Also fix
 the '''paremeter''' typos.

 The comment for
 {{{
 template<typename Type, typename Translator>
   self_type & put(const path_type & path, const Type & value, Translator
 tr)
 }}}
 should probably say '''translated with the supplied translator''' to
 distinguish this method from the default translator version.

 Remove the quoting of < and > in the code explaining the get_optional()
 methods.
 {{{
 if(optional\<const self_type&\> node = get_child_optional(path))
 }}}

 In:
 http://www.boost.org/doc/libs/1_46_1/doc/html/boost_propertytree/parsers.html#boost_propertytree.parsers.json_parser


 There is a bad trailing comma in this line of the example:

 {{{
 {"value": "Open", "onclick": "OpenDoc()"},
 }}}

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/3925#comment:5>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.