diff --git a/doc/property_tree.qbk b/doc/property_tree.qbk index 83f6a6bc8..925fb6a21 100644 --- a/doc/property_tree.qbk +++ b/doc/property_tree.qbk @@ -102,7 +102,7 @@ these three basic patterns of usage: assignments. Or when tomorrow is final deadline for your project. * ['Get the data and revert to default value if it cannot be done.] Used when you want to allow omitting the key in question. Implemented by some similar - tools (windows INI file access functions). + tools (Windows INI file access functions). * ['Get the data, but I care more whether you succeeded than I do for the data itself.] Used when you want to vary control flow depending on get success/failure. Or to check for presence of a key. diff --git a/doc/xml_parser.qbk b/doc/xml_parser.qbk index 8a9a9b1d0..27b2fe3c8 100644 --- a/doc/xml_parser.qbk +++ b/doc/xml_parser.qbk @@ -18,7 +18,7 @@ RapidXML does not fully support the XML standard; it is not capable of parsing DTDs and therefore cannot do full entity substitution. By default, the parser will preserve most whitespace, but remove element content -that consists only of whitespace. Encoded whitespaces (e.g. ) does not +that consists only of whitespace. Encoded whitespaces (e.g. ) do not count as whitespace in this regard. You can pass the trim_whitespace flag if you want all leading and trailing whitespace trimmed and all continuous whitespace collapsed into a single space. diff --git a/include/boost/property_tree/info_parser.hpp b/include/boost/property_tree/info_parser.hpp index 683ddad46..b38b6d3cc 100644 --- a/include/boost/property_tree/info_parser.hpp +++ b/include/boost/property_tree/info_parser.hpp @@ -21,7 +21,7 @@ namespace boost { namespace property_tree { namespace info_parser { /** - * Read INFO from a the given stream and translate it to a property tree. + * Read INFO from the given stream and translate it to a property tree. * @note Replaces the existing contents. Strong exception guarantee. * @throw info_parser_error If the stream cannot be read, doesn't contain * valid INFO, or a conversion fails. @@ -35,7 +35,7 @@ namespace boost { namespace property_tree { namespace info_parser } /** - * Read INFO from a the given stream and translate it to a property tree. + * Read INFO from the given stream and translate it to a property tree. * @note Replaces the existing contents. Strong exception guarantee. * @param default_ptree If parsing fails, pt is set to a copy of this tree. */ @@ -51,7 +51,7 @@ namespace boost { namespace property_tree { namespace info_parser } /** - * Read INFO from a the given file and translate it to a property tree. The + * Read INFO from the given file and translate it to a property tree. The * tree's key type must be a string type, i.e. it must have a nested * value_type typedef that is a valid parameter for basic_ifstream. * @note Replaces the existing contents. Strong exception guarantee. @@ -75,7 +75,7 @@ namespace boost { namespace property_tree { namespace info_parser } /** - * Read INFO from a the given file and translate it to a property tree. The + * Read INFO from the given file and translate it to a property tree. The * tree's key type must be a string type, i.e. it must have a nested * value_type typedef that is a valid parameter for basic_ifstream. * @note Replaces the existing contents. Strong exception guarantee. diff --git a/include/boost/property_tree/ini_parser.hpp b/include/boost/property_tree/ini_parser.hpp index 80cdc602c..86962b9ff 100644 --- a/include/boost/property_tree/ini_parser.hpp +++ b/include/boost/property_tree/ini_parser.hpp @@ -54,7 +54,7 @@ namespace boost { namespace property_tree { namespace ini_parser }; /** - * Read INI from a the given stream and translate it to a property tree. + * Read INI from the given stream and translate it to a property tree. * @note Clears existing contents of property tree. In case of error * the property tree is not modified. * @throw ini_parser_error If a format violation is found. @@ -146,9 +146,9 @@ namespace boost { namespace property_tree { namespace ini_parser } /** - * Read INI from a the given file and translate it to a property tree. + * Read INI from the given file and translate it to a property tree. * @note Clears existing contents of property tree. In case of error the - * property tree unmodified. + * property tree is not modified. * @throw ini_parser_error In case of error deserializing the property tree. * @param filename Name of file from which to read in the property tree. * @param[out] pt The property tree to populate. @@ -250,7 +250,7 @@ namespace boost { namespace property_tree { namespace ini_parser } /** - * Translates the property tree to INI and writes it the given output + * Translates the property tree to INI and writes it to the given output * stream. * @pre @e pt cannot have data in its root. * @pre @e pt cannot have keys both data and children. @@ -260,7 +260,7 @@ namespace boost { namespace property_tree { namespace ini_parser * INI or writing to the output stream. * @param stream The stream to which to write the INI representation of the * property tree. - * @param pt The property tree to tranlsate to INI and output. + * @param pt The property tree to translate to INI and output. * @param flags The flags to use when writing the INI file. * No flags are currently supported. */ @@ -284,7 +284,7 @@ namespace boost { namespace property_tree { namespace ini_parser } /** - * Translates the property tree to INI and writes it the given file. + * Translates the property tree to INI and writes it to the given file. * @pre @e pt cannot have data in its root. * @pre @e pt cannot have keys both data and children. * @pre @e pt cannot be deeper than two levels. @@ -293,7 +293,7 @@ namespace boost { namespace property_tree { namespace ini_parser * to INI or writing to the file. * @param filename The name of the file to which to write the INI * representation of the property tree. - * @param pt The property tree to tranlsate to INI and output. + * @param pt The property tree to translate to INI and output. * @param flags The flags to use when writing the INI file. * The following flags are supported: * @li @c skip_ini_validity_check -- Skip check if ptree is a valid ini. The diff --git a/include/boost/property_tree/json_parser.hpp b/include/boost/property_tree/json_parser.hpp index 62fd89f85..49aeca3fd 100644 --- a/include/boost/property_tree/json_parser.hpp +++ b/include/boost/property_tree/json_parser.hpp @@ -24,9 +24,9 @@ namespace boost { namespace property_tree { namespace json_parser { /** - * Read JSON from a the given stream and translate it to a property tree. + * Read JSON from the given stream and translate it to a property tree. * @note Clears existing contents of property tree. In case of error the - * property tree unmodified. + * property tree is not modified. * @note Items of JSON arrays are translated into ptree keys with empty * names. Members of objects are translated into named keys. * @note JSON data can be a string, a numeric value, or one of literals @@ -47,9 +47,9 @@ namespace boost { namespace property_tree { namespace json_parser } /** - * Read JSON from a the given file and translate it to a property tree. + * Read JSON from the given file and translate it to a property tree. * @note Clears existing contents of property tree. In case of error the - * property tree unmodified. + * property tree is not modified. * @note Items of JSON arrays are translated into ptree keys with empty * names. Members of objects are translated into named keys. * @note JSON data can be a string, a numeric value, or one of literals @@ -76,7 +76,7 @@ namespace boost { namespace property_tree { namespace json_parser } /** - * Translates the property tree to JSON and writes it the given output + * Translates the property tree to JSON and writes it to the given output * stream. * @note Any property tree key containing only unnamed subkeys will be * rendered as JSON arrays. @@ -85,7 +85,7 @@ namespace boost { namespace property_tree { namespace json_parser * to JSON or writing to the output stream. * @param stream The stream to which to write the JSON representation of the * property tree. - * @param pt The property tree to tranlsate to JSON and output. + * @param pt The property tree to translate to JSON and output. * @param pretty Whether to pretty-print. Defaults to true for backward * compatibility. */ @@ -100,7 +100,7 @@ namespace boost { namespace property_tree { namespace json_parser } /** - * Translates the property tree to JSON and writes it the given file. + * Translates the property tree to JSON and writes it to the given file. * @note Any property tree key containing only unnamed subkeys will be * rendered as JSON arrays. * @pre @e pt cannot contain keys that have both subkeys and non-empty data. diff --git a/include/boost/property_tree/ptree.hpp b/include/boost/property_tree/ptree.hpp index 2743123c9..cc3708179 100644 --- a/include/boost/property_tree/ptree.hpp +++ b/include/boost/property_tree/ptree.hpp @@ -462,7 +462,7 @@ namespace boost { namespace property_tree /** If the node identified by the path does not exist, create it, * including all its missing parents. * If the node already exists, add a sibling with the same key. - * Set the newly created node's value to the given paremeter, + * Set the newly created node's value to the given parameter, * translated with the supplied translator. * @param path Path to the child. The last fragment must not have an * index. @@ -479,7 +479,7 @@ namespace boost { namespace property_tree /** If the node identified by the path does not exist, create it, * including all its missing parents. * If the node already exists, add a sibling with the same key. - * Set the newly created node's value to the given paremeter, + * Set the newly created node's value to the given parameter, * translated with the supplied translator. * @param path Path to the child. The last fragment must not have an * index. diff --git a/include/boost/property_tree/string_path.hpp b/include/boost/property_tree/string_path.hpp index de2abc0a4..3dc925ab9 100644 --- a/include/boost/property_tree/string_path.hpp +++ b/include/boost/property_tree/string_path.hpp @@ -74,9 +74,9 @@ namespace boost { namespace property_tree /// If instantiated with std::string and id_translator\, /// it accepts paths of the form "one.two.three.four". /// - /// @tparam String Any Sequence. If the sequence does not support random- - /// access iteration, concatenation of paths assumes that - /// insertions at the end preserve iterator validity. + /// @tparam String Any Sequence. If the sequence does not support + /// random-access iteration, concatenation of paths assumes + /// that insertions at the end preserve iterator validity. /// @tparam Translator A translator with internal_type == String. template class string_path @@ -98,8 +98,8 @@ namespace boost { namespace property_tree string_path(const String &value, char_type separator = char_type('.'), Translator tr = Translator()); /// Create a path by parsing the given string. - /// @param value A zero-terminated array of values. Only use if zero- - /// termination makes sense for your type, and your + /// @param value A zero-terminated array of values. Only use if + /// zero-termination makes sense for your type, and your /// sequence supports construction from it. Intended for /// string literals. /// @param separator The separator used in parsing. Defaults to '.'. diff --git a/include/boost/property_tree/xml_parser.hpp b/include/boost/property_tree/xml_parser.hpp index 0544c5554..0da68e481 100644 --- a/include/boost/property_tree/xml_parser.hpp +++ b/include/boost/property_tree/xml_parser.hpp @@ -28,7 +28,7 @@ namespace boost { namespace property_tree { namespace xml_parser /** * Reads XML from an input stream and translates it to property tree. * @note Clears existing contents of property tree. In case of error the - * property tree unmodified. + * property tree is not modified. * @note XML attributes are placed under keys named @c \. * @throw xml_parser_error In case of error deserializing the property tree. * @param stream Stream from which to read in the property tree. @@ -56,12 +56,12 @@ namespace boost { namespace property_tree { namespace xml_parser * Reads XML from a file using the given locale and translates it to * property tree. * @note Clears existing contents of property tree. In case of error the - * property tree unmodified. + * property tree is not modified. * @note XML attributes are placed under keys named @c \. * @throw xml_parser_error In case of error deserializing the property tree. * @param filename The file from which to read in the property tree. * @param[out] pt The property tree to populate. - * @param flags Flags controlling the bahviour of the parser. + * @param flags Flags controlling the behaviour of the parser. * The following flags are supported: * @li @c no_concat_text -- Prevents concatenation of text nodes into * datastring of property tree. Puts them in @@ -86,13 +86,13 @@ namespace boost { namespace property_tree { namespace xml_parser } /** - * Translates the property tree to XML and writes it the given output + * Translates the property tree to XML and writes it to the given output * stream. * @throw xml_parser_error In case of error translating the property tree to * XML or writing to the output stream. * @param stream The stream to which to write the XML representation of the * property tree. - * @param pt The property tree to tranlsate to XML and output. + * @param pt The property tree to translate to XML and output. * @param settings The settings to use when writing out the property tree as * XML. */ @@ -110,12 +110,12 @@ namespace boost { namespace property_tree { namespace xml_parser } /** - * Translates the property tree to XML and writes it the given file. + * Translates the property tree to XML and writes it to the given file. * @throw xml_parser_error In case of error translating the property tree to * XML or writing to the output stream. * @param filename The file to which to write the XML representation of the * property tree. - * @param pt The property tree to tranlsate to XML and output. + * @param pt The property tree to translate to XML and output. * @param loc The locale to use when writing the output to file. * @param settings The settings to use when writing out the property tree as * XML.