diff --git a/doc/qbk/main.qbk b/doc/qbk/main.qbk index 9d30d5c..a74a376 100644 --- a/doc/qbk/main.qbk +++ b/doc/qbk/main.qbk @@ -1,6 +1,6 @@ [/ Copyright (c) 2016-2019 Vinnie Falco (vinnie dot falco at gmail dot com) - Copyright (c) 2019 Krystian Stasiowski (sdkrystian at gmail dot com) + Copyright (c) 2019-2020 Krystian Stasiowski (sdkrystian at gmail dot com) Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) @@ -12,7 +12,7 @@ [id static_string] [quickbook 1.6] [copyright 2016 - 2019 Vinnie Falco] - [copyright 2019 Krystian Stasiowski] + [copyright 2019 - 2020 Krystian Stasiowski] [purpose String Library] [license Distributed under the Boost Software License, Version 1.0. @@ -40,7 +40,7 @@ This library provides a dynamically resizable string of characters with compile-time fixed capacity and contiguous embedded storage in which the characters are placed within the string object itself. Its API closely -resembles that of `std::string` +resembles that of `std::string`. [/-----------------------------------------------------------------------------] @@ -78,7 +78,8 @@ algorithms which throw exceptions provide the strong exception safety guarantee. This is intended to be a drop in replacement for `std::string`. The API of `static_string` only diverges from `std::string` in few places, -being `substr` for which this implementation returns a string view instead of `static_string`, +one of which is the addition of the `subview` function, for which this implementation +returns a string view instead of `static_string`, and certain functions that will never throw are marked as `noexcept`, which diverges from those of `std::string`. The available overloads for `static_string` are identical to those of `std::string`. @@ -96,9 +97,9 @@ The iterator invalidation rules differ from those of `std::string`: [heading Optimizations] -Depending on the character type and size used for a specialization of `static_string`, certain optimizations are used to reduce the size of the class type. Given the name of a specialization of the form `static_string`: +Depending on the character type and size used for a specialization of `static_string`, certain optimizations are used to reduce the size of the class type. Given the name of a specialization of the form `basic_static_string`: -* If `N` is 0, then the class has no non-static data members. Given two objects `a` and `b` of type `static_string<0, T>` and `static_string<0, U>` respectively, the pointer value returned by `data()` will be the same if `T` and `U` are the same. +* If `N` is 0, then the class has no non-static data members. Given two objects `a` and `b` of type `basic_static_string<0, T, Traits>` and `static_string<0, U, Traits>` respectively, the pointer value returned by `data()` will be the same if `T` and `U` are the same. * Otherwise, the type of the member used to store the size of the `static_string` will be the smallest standard unsigned integer type that can represent the value `N`. @@ -112,9 +113,19 @@ Certain features can be enabled and disabled though defining configuration macro [/-----------------------------------------------------------------------------] +[heading Acknowledgments] + +Thanks to [@@https://github.com/K-ballo Agustín Bergé], [@https://github.com/pdimov Peter Dimov], [@https://github.com/glenfe Glen Fernandes], and [@https://github.com/LeonineKing1199 Christian Mazakas] for their constant feedback and guidance during the development of this library. + +The development of this library was sponsored by [@https://cppalliance.org The C++ Alliance]. + +[/-----------------------------------------------------------------------------] + [heading Reference] -[link static_string.ref.boost__static_string__static_string `static_string`] +Defined in namespace `boost::static_strings`: + +[link static_string.ref.boost__static_strings__basic_static_string `basic_static_string`] [/-----------------------------------------------------------------------------] @@ -124,4 +135,4 @@ Certain features can be enabled and disabled though defining configuration macro [/-----------------------------------------------------------------------------] -[xinclude index.xml] +[xinclude index.xml] \ No newline at end of file diff --git a/doc/xsl/config.xsl b/doc/xsl/config.xsl index 348cbea..813a951 100644 --- a/doc/xsl/config.xsl +++ b/doc/xsl/config.xsl @@ -1,6 +1,6 @@ - + diff --git a/meta/libraries.json b/meta/libraries.json index 2b0c9c3..de5b60d 100644 --- a/meta/libraries.json +++ b/meta/libraries.json @@ -2,7 +2,7 @@ "key": "static_string", "name": "StaticString", "authors": [ - "Vinnie Falco" + "Vinnie Falco", "Krystian Stasiowski" ], "description": "A fixed capacity dynamically sized string.",