Boost C++ Libraries: Ticket #3925: Property tree documentation is seriously out of date

anonymous — Tue, 16 Feb 2010 14:39:29 GMT

There's also http://www.boost.org/doc/libs/1_42_0/doc/html/boost_propertytree/accessing.html which is just plain wrong on access like:

pt.get<float>('/', "p.a.t.h/t.o/v.a.l.u.e");

This is actually done like this:

pt.get<float>(ptree::path_type("p.a.t.h/t.o/v.a.l.u.e", '/'));

summary changed

anonymous — Tue, 16 Feb 2010 14:39:49 GMT

summary Property tree documentation has a lot of formatting bugs → Property tree documentation is seriously out of date

Thu, 20 Jan 2011 19:21:01 GMT

These problems persist in 1.45. accessing.html also mentions __ptree_put_own__ on the last line. (I think it should be put_value instead.)

Sebastian Redl — Mon, 16 May 2011 18:52:39 GMT

Big improvements in r71994, but still work to do.

anonymous — Mon, 11 Jul 2011 05:37:00 GMT

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()"},

monsta@… — Tue, 06 Sep 2011 06:52:16 GMT

The description of translators is still basically non-existent as of Boost 1.47. I've managed to figure out most of the internal mechanics by scrutinizing id_translator.hpp and stream_translator.hpp, but I guess that's not acceptable for everyone.

anonymous — Wed, 21 Mar 2012 09:55:33 GMT

Still the same as of Boost 1.49.

anonymous — Fri, 20 Dec 2013 10:47:51 GMT

Hey, still the same in Boost 1.55. Is there a maintainer? Should we elect a new one?