mirror of
https://github.com/boostorg/utility.git
synced 2025-05-08 18:34:02 +00:00
Add quickbook documentation structure
This commit is contained in:
Alan de Freitas
parent
703a4bf752
commit
0171af0f77
227
doc/main.qbk
Normal file
227
doc/main.qbk
Normal file
@ -0,0 +1,227 @@
|
||||
[/
|
||||
Copyright (c) 2021, Alan Freitas
|
||||
|
||||
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)
|
||||
|
||||
Official repository: https://github.com/boostorg/utility
|
||||
]
|
||||
|
||||
[/#############################################
|
||||
DOCUMENT INFO
|
||||
###############################################]
|
||||
|
||||
[library Boost.Utility
|
||||
[id utility]
|
||||
[quickbook 1.6]
|
||||
[copyright 2001 Beman Dawes]
|
||||
[purpose Utility Library]
|
||||
[license
|
||||
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])
|
||||
]
|
||||
[authors [Dawes, Beman]]
|
||||
[category template]
|
||||
[category generic]
|
||||
]
|
||||
|
||||
[template mdash[] '''— ''']
|
||||
[template indexterm1[term1] '''<indexterm><primary>'''[term1]'''</primary></indexterm>''']
|
||||
[template indexterm2[term1 term2] '''<indexterm><primary>'''[term1]'''</primary><secondary>'''[term2]'''</secondary></indexterm>''']
|
||||
|
||||
[template include_file[path][^<'''<ulink url="https://github.com/boostorg/utility/blob/master/include/'''[path]'''">'''[path]'''</ulink>'''>]]
|
||||
[template issue[n] '''<ulink url="https://github.com/boostorg/utility/issues/'''[n]'''">#'''[n]'''</ulink>''']
|
||||
|
||||
[/ Named Requirements ]
|
||||
|
||||
[def __Handler__ ['Handler]]
|
||||
[def __Allocator__ [@https://en.cppreference.com/w/cpp/named_req/Allocator ['Allocator]]]
|
||||
[def __CopyAssignable__ [@https://en.cppreference.com/w/cpp/named_req/CopyAssignable ['CopyAssignable]]]
|
||||
[def __CopyConstructible__ [@https://en.cppreference.com/w/cpp/named_req/CopyConstructible ['CopyConstructible]]]
|
||||
[def __Copyable__ [@https://en.cppreference.com/w/cpp/concepts/copyable ['Copyable]]]
|
||||
[def __DefaultConstructible__ [@https://en.cppreference.com/w/cpp/named_req/DefaultConstructible ['DefaultConstructible]]]
|
||||
[def __Hash__ [@https://en.cppreference.com/w/cpp/named_req/Hash ['Hash]]]
|
||||
[def __InputIterator__ [@https://en.cppreference.com/w/cpp/named_req/InputIterator ['InputIterator]]]
|
||||
[def __MoveAssignable__ [@https://en.cppreference.com/w/cpp/named_req/MoveAssignable ['MoveAssignable]]]
|
||||
[def __MoveConstructible__ [@https://en.cppreference.com/w/cpp/named_req/MoveConstructible ['MoveConstructible]]]
|
||||
[def __RandomAccessIterator__ [@https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator ['RandomAccessIterator]]]
|
||||
[def __Regular__ [@https://en.cppreference.com/w/cpp/concepts/regular ['Regular]]]
|
||||
[def __Swappable__ [@https://en.cppreference.com/w/cpp/named_req/Swappable ['Swappable]]]
|
||||
|
||||
[/ Boost types ]
|
||||
|
||||
[def __BOOST_BINARY__ [link sec:BOOST_BINARY `BOOST_BINARY`]]
|
||||
[def __in_place_factory__ [link sec:in_place_factory `in_place_factory`]]
|
||||
|
||||
[def __boost_base_from_member__ [link utility.index_and_ref.ref.boost__base_from_member `boost::base_from_member`]]
|
||||
[def __boost_call_traits__ [link utility.index_and_ref.ref.boost__call_traits `boost::call_traits`]]
|
||||
[def __boost_result_of__ [link utility.index_and_ref.ref.boost__result_of `boost::result_of`]]
|
||||
[def __boost_tr1_result_of__ [link utility.index_and_ref.ref.boost__tr1_result_of `boost::tr1_result_of`]]
|
||||
[def __boost_string_view__ [link utility.index_and_ref.ref.boost__string_view `boost::string_view`]]
|
||||
[def __boost_basic_string_view__ [link utility.index_and_ref.ref.boost__basic_string_view `boost::basic_string_view`]]
|
||||
|
||||
[def __additive1__ [link utility.index_and_ref.ref.boost__additive1 `additive1`]]
|
||||
[def __additive2__ [link utility.index_and_ref.ref.boost__additive2 `additive2`]]
|
||||
[def __arithmetic1__ [link utility.index_and_ref.ref.boost__arithmetic1 `arithmetic1`]]
|
||||
[def __arithmetic2__ [link utility.index_and_ref.ref.boost__arithmetic2 `arithmetic2`]]
|
||||
[def __base_from_member__ [link utility.index_and_ref.ref.boost__base_from_member `base_from_member`]]
|
||||
[def __basic_string_ref__ [link utility.index_and_ref.ref.boost__basic_string_ref `basic_string_ref`]]
|
||||
[def __basic_string_view__ [link utility.index_and_ref.ref.boost__basic_string_view `basic_string_view`]]
|
||||
[def __bidirectional_iteratable__ [link utility.index_and_ref.ref.boost__bidirectional_iteratable `bidirectional_iteratable`]]
|
||||
[def __bidirectional_iterator_helper__ [link utility.index_and_ref.ref.boost__bidirectional_iterator_helper `bidirectional_iterator_helper`]]
|
||||
[def __bitwise1__ [link utility.index_and_ref.ref.boost__bitwise1 `bitwise1`]]
|
||||
[def __bitwise2__ [link utility.index_and_ref.ref.boost__bitwise2 `bitwise2`]]
|
||||
[def __call_traits__ [link utility.index_and_ref.ref.boost__call_traits `call_traits`]]
|
||||
[def __call_traits_T__ [link utility.index_and_ref.ref.boost__call_traits `call_traits<T>`]]
|
||||
[def __call_traits_lt__T___ [link utility.index_and_ref.ref.boost__call_traits_lt__T_ `call_traits<T&>`]]
|
||||
[def __call_traits_lt__T_lb_N_rb__gt___ [link utility.index_and_ref.ref.boost__call_traits_lt__T_lb_N_rb__gt_ `call_traits< T[N]>`]]
|
||||
[def __call_traits_lt__const_T_lb_N_rb__gt___ [link utility.index_and_ref.ref.boost__call_traits_lt__const_T_lb_N_rb__gt_ `call_traits< const T[N]>`]]
|
||||
[def __compressed_pair__ [link utility.index_and_ref.ref.boost__compressed_pair `compressed_pair`]]
|
||||
[def __decrementable__ [link utility.index_and_ref.ref.boost__decrementable `decrementable`]]
|
||||
[def __dereferenceable__ [link utility.index_and_ref.ref.boost__dereferenceable `dereferenceable`]]
|
||||
[def __equal_pointees__ [link utility.index_and_ref.ref.boost__equal_pointees `equal_pointees`]]
|
||||
[def __equal_pointees_t__ [link utility.index_and_ref.ref.boost__equal_pointees_t `equal_pointees_t`]]
|
||||
[def __equality_comparable1__ [link utility.index_and_ref.ref.boost__equality_comparable1 `equality_comparable1`]]
|
||||
[def __equality_comparable2__ [link utility.index_and_ref.ref.boost__equality_comparable2 `equality_comparable2`]]
|
||||
[def __equivalent1__ [link utility.index_and_ref.ref.boost__equivalent1 `equivalent1`]]
|
||||
[def __equivalent2__ [link utility.index_and_ref.ref.boost__equivalent2 `equivalent2`]]
|
||||
[def __euclidean_ring_operators1__ [link utility.index_and_ref.ref.boost__euclidean_ring_operators1 `euclidean_ring_operators1`]]
|
||||
[def __euclidean_ring_operators2__ [link utility.index_and_ref.ref.boost__euclidean_ring_operators2 `euclidean_ring_operators2`]]
|
||||
[def __field_operators1__ [link utility.index_and_ref.ref.boost__field_operators1 `field_operators1`]]
|
||||
[def __field_operators2__ [link utility.index_and_ref.ref.boost__field_operators2 `field_operators2`]]
|
||||
[def __forward_iteratable__ [link utility.index_and_ref.ref.boost__forward_iteratable `forward_iteratable`]]
|
||||
[def __forward_iterator_helper__ [link utility.index_and_ref.ref.boost__forward_iterator_helper `forward_iterator_helper`]]
|
||||
[def __get__ [link utility.index_and_ref.ref.boost__get `get`]]
|
||||
[def __hash_range__ [link utility.index_and_ref.ref.boost__hash_range `hash_range`]]
|
||||
[def __hash_value__ [link utility.index_and_ref.ref.boost__hash_value `hash_value`]]
|
||||
[def __in_place_factory_base__ [link utility.index_and_ref.ref.boost__in_place_factory_base `in_place_factory_base`]]
|
||||
[def __incrementable__ [link utility.index_and_ref.ref.boost__incrementable `incrementable`]]
|
||||
[def __indexable__ [link utility.index_and_ref.ref.boost__indexable `indexable`]]
|
||||
[def __initialized__ [link utility.index_and_ref.ref.boost__initialized `initialized`]]
|
||||
[def __initialized_value__ [link utility.index_and_ref.ref.boost__initialized_value `initialized_value`]]
|
||||
[def __initialized_value_t__ [link utility.index_and_ref.ref.boost__initialized_value_t `initialized_value_t`]]
|
||||
[def __input_iteratable__ [link utility.index_and_ref.ref.boost__input_iteratable `input_iteratable`]]
|
||||
[def __input_iterator_helper__ [link utility.index_and_ref.ref.boost__input_iterator_helper `input_iterator_helper`]]
|
||||
[def __integer_arithmetic1__ [link utility.index_and_ref.ref.boost__integer_arithmetic1 `integer_arithmetic1`]]
|
||||
[def __integer_arithmetic2__ [link utility.index_and_ref.ref.boost__integer_arithmetic2 `integer_arithmetic2`]]
|
||||
[def __integer_multiplicative1__ [link utility.index_and_ref.ref.boost__integer_multiplicative1 `integer_multiplicative1`]]
|
||||
[def __integer_multiplicative2__ [link utility.index_and_ref.ref.boost__integer_multiplicative2 `integer_multiplicative2`]]
|
||||
[def __is_chained_base__ [link utility.index_and_ref.ref.boost__is_chained_base `is_chained_base`]]
|
||||
[def __less_pointees__ [link utility.index_and_ref.ref.boost__less_pointees `less_pointees`]]
|
||||
[def __less_pointees_t__ [link utility.index_and_ref.ref.boost__less_pointees_t `less_pointees_t`]]
|
||||
[def __less_than_comparable1__ [link utility.index_and_ref.ref.boost__less_than_comparable1 `less_than_comparable1`]]
|
||||
[def __less_than_comparable2__ [link utility.index_and_ref.ref.boost__less_than_comparable2 `less_than_comparable2`]]
|
||||
[def __multiplicative1__ [link utility.index_and_ref.ref.boost__multiplicative1 `multiplicative1`]]
|
||||
[def __multiplicative2__ [link utility.index_and_ref.ref.boost__multiplicative2 `multiplicative2`]]
|
||||
[def __operator_eq__eq__ [link utility.index_and_ref.ref.boost__operator_eq__eq_ `operator==`]]
|
||||
[def __operator_gt__ [link utility.index_and_ref.ref.boost__operator_gt_ `operator_gt_`]]
|
||||
[def __operator_gt__eq__ [link utility.index_and_ref.ref.boost__operator_gt__eq_ `operator>`]]
|
||||
[def __operator_lt__ [link utility.index_and_ref.ref.boost__operator_lt_ `operator<`]]
|
||||
[def __operator_lt__eq__ [link utility.index_and_ref.ref.boost__operator_lt__eq_ `operator<=`]]
|
||||
[def __operator_lt__lt__ [link utility.index_and_ref.ref.boost__operator_lt__lt_ `operator<<`]]
|
||||
[def __operator_not__eq__ [link utility.index_and_ref.ref.boost__operator_not__eq_ `operator!=`]]
|
||||
[def __operators2__ [link utility.index_and_ref.ref.boost__operators2 `operators2`]]
|
||||
[def __operators__ [link utility.index_and_ref.ref.boost__operators `operators`]]
|
||||
[def __operators_lt_T__ [link utility.index_and_ref.ref.boost__operators_lt_T `operators<T,T>`]]
|
||||
[def __ordered_euclidean_ring_operators1__ [link utility.index_and_ref.ref.boost__ordered_euclidean_ring_operators1 `ordered_euclidean_ring_operators1`]]
|
||||
[def __ordered_euclidean_ring_operators2__ [link utility.index_and_ref.ref.boost__ordered_euclidean_ring_operators2 `ordered_euclidean_ring_operators2`]]
|
||||
[def __ordered_euclidian_ring_operators1__ [link utility.index_and_ref.ref.boost__ordered_euclidian_ring_operators1 `ordered_euclidian_ring_operators1`]]
|
||||
[def __ordered_euclidian_ring_operators2__ [link utility.index_and_ref.ref.boost__ordered_euclidian_ring_operators2 `ordered_euclidian_ring_operators2`]]
|
||||
[def __ordered_field_operators1__ [link utility.index_and_ref.ref.boost__ordered_field_operators1 `ordered_field_operators1`]]
|
||||
[def __ordered_field_operators2__ [link utility.index_and_ref.ref.boost__ordered_field_operators2 `ordered_field_operators2`]]
|
||||
[def __ordered_ring_operators1__ [link utility.index_and_ref.ref.boost__ordered_ring_operators1 `ordered_ring_operators1`]]
|
||||
[def __ordered_ring_operators2__ [link utility.index_and_ref.ref.boost__ordered_ring_operators2 `ordered_ring_operators2`]]
|
||||
[def __output_iteratable__ [link utility.index_and_ref.ref.boost__output_iteratable `output_iteratable`]]
|
||||
[def __output_iterator_helper__ [link utility.index_and_ref.ref.boost__output_iterator_helper `output_iterator_helper`]]
|
||||
[def __partially_ordered1__ [link utility.index_and_ref.ref.boost__partially_ordered1 `partially_ordered1`]]
|
||||
[def __partially_ordered2__ [link utility.index_and_ref.ref.boost__partially_ordered2 `partially_ordered2`]]
|
||||
[def __random_access_iteratable__ [link utility.index_and_ref.ref.boost__random_access_iteratable `random_access_iteratable`]]
|
||||
[def __random_access_iterator_helper__ [link utility.index_and_ref.ref.boost__random_access_iterator_helper `random_access_iterator_helper`]]
|
||||
[def __result_of__ [link utility.index_and_ref.ref.boost__result_of `result_of`]]
|
||||
[def __ring_operators1__ [link utility.index_and_ref.ref.boost__ring_operators1 `ring_operators1`]]
|
||||
[def __ring_operators2__ [link utility.index_and_ref.ref.boost__ring_operators2 `ring_operators2`]]
|
||||
[def __shiftable1__ [link utility.index_and_ref.ref.boost__shiftable1 `shiftable1`]]
|
||||
[def __shiftable2__ [link utility.index_and_ref.ref.boost__shiftable2 `shiftable2`]]
|
||||
[def __string_ref__ [link utility.index_and_ref.ref.boost__string_ref `string_ref`]]
|
||||
[def __string_view__ [link utility.index_and_ref.ref.boost__string_view `string_view`]]
|
||||
[def __swap__ [link utility.index_and_ref.ref.boost__swap `swap`]]
|
||||
[def __totally_ordered1__ [link utility.index_and_ref.ref.boost__totally_ordered1 `totally_ordered1`]]
|
||||
[def __totally_ordered2__ [link utility.index_and_ref.ref.boost__totally_ordered2 `totally_ordered2`]]
|
||||
[def __tr1_result_of__ [link utility.index_and_ref.ref.boost__tr1_result_of `tr1_result_of`]]
|
||||
[def __typed_in_place_factory_base__ [link utility.index_and_ref.ref.boost__typed_in_place_factory_base `typed_in_place_factory_base`]]
|
||||
[def __u16string_ref__ [link utility.index_and_ref.ref.boost__u16string_ref `u16string_ref`]]
|
||||
[def __u16string_view__ [link utility.index_and_ref.ref.boost__u16string_view `u16string_view`]]
|
||||
[def __u32string_ref__ [link utility.index_and_ref.ref.boost__u32string_ref `u32string_ref`]]
|
||||
[def __u32string_view__ [link utility.index_and_ref.ref.boost__u32string_view `u32string_view`]]
|
||||
[def __unit_steppable__ [link utility.index_and_ref.ref.boost__unit_steppable `unit_steppable`]]
|
||||
[def __value_initialized__ [link utility.index_and_ref.ref.boost__value_initialized `value_initialized`]]
|
||||
[def __wstring_ref__ [link utility.index_and_ref.ref.boost__wstring_ref `wstring_ref`]]
|
||||
[def __wstring_view__ [link utility.index_and_ref.ref.boost__wstring_view `wstring_view`]]
|
||||
|
||||
[/ std:: types ]
|
||||
|
||||
[def __assert__ [@https://en.cppreference.com/w/cpp/error/assert `assert`]]
|
||||
[def __decltype__ [@https://en.cppreference.com/w/cpp/language/decltype `decltype`]]
|
||||
[def __initializer_list__ [@https://en.cppreference.com/w/cpp/utility/initializer_list `std::initializer_list`]]
|
||||
[def __nullptr__ [@https://en.cppreference.com/w/cpp/language/nullptr `nullptr`]]
|
||||
[def __std_addressof__ [@https://en.cppreference.com/w/cpp/memory/addressof `std::addressof`]]
|
||||
[def __std_array__ [@https://en.cppreference.com/w/cpp/container/array `std::array`]]
|
||||
[def __std_basic_string__ [@https://en.cppreference.com/w/cpp/string/basic_string `std::basic_string`]]
|
||||
[def __std_basic_string_view__ [@https://en.cppreference.com/w/cpp/string/basic_string_view `std::basic_string_view`]]
|
||||
[def __std_binder1st__ [@https://en.cppreference.com/w/cpp/utility/functional/binder12 `std::binder1st`]]
|
||||
[def __std_complex__ [@https://en.cppreference.com/w/cpp/numeric/complex `std::complex`]]
|
||||
[def __std_declval__ [@https://en.cppreference.com/w/cpp/utility/declval `std::declval`]]
|
||||
[def __std_enable_if__ [@https://en.cppreference.com/w/cpp/types/enable_if `std::enable_if`]]
|
||||
[def __std_enable_if_t__ [@https://en.cppreference.com/w/cpp/types/enable_if `std::enable_if_t`]]
|
||||
[def __std_fill__ [@https://en.cppreference.com/w/cpp/algorithm/fill `std::fill`]]
|
||||
[def __std_hash__ [@https://en.cppreference.com/w/cpp/utility/hash `std::hash`]]
|
||||
[def __std_initializer_list__ [@https://en.cppreference.com/w/cpp/utility/initializer_list `std::initializer_list`]]
|
||||
[def __std_is_nothrow_constructible__ [@https://en.cppreference.com/w/cpp/types/is_constructible `std::is_nothrow_constructible`]]
|
||||
[def __std_make_pair__ [@https://en.cppreference.com/w/cpp/utility/pair/make_pair `std::make_pair`]]
|
||||
[def __std_memory_resource__ [@https://en.cppreference.com/w/cpp/memory/memory_resource `std::pmr::memory_resource`]]
|
||||
[def __std_memset__ [@https://en.cppreference.com/w/cpp/string/byte/memset `std::memset`]]
|
||||
[def __std_next__ [@https://en.cppreference.com/w/cpp/iterator/next `std::next`]]
|
||||
[def __std_nullptr_t__ [@https://en.cppreference.com/w/cpp/types/nullptr_t `std::nullptr_t`]]
|
||||
[def __std_ostream__ [@https://en.cppreference.com/w/cpp/io/basic_ostream `std::ostream`]]
|
||||
[def __std_ostream__ [@https://en.cppreference.com/w/cpp/io/basic_ostream `__std_ostream__`]]
|
||||
[def __std_pair__ [@https://en.cppreference.com/w/cpp/utility/pair `std::pair`]]
|
||||
[def __std_polymorphic_allocator__ [@https://en.cppreference.com/w/cpp/memory/polymorphic_allocator `std::pmr::polymorphic_allocator`]]
|
||||
[def __std_prev__ [@https://en.cppreference.com/w/cpp/iterator/prev `std::prev`]]
|
||||
[def __std_ptrdiff_t__ [@https://en.cppreference.com/w/cpp/types/ptrdiff_t `std::ptrdiff_t`]]
|
||||
[def __std_remove__ [@https://en.cppreference.com/w/cpp/algorithm/remove `std::remove`]]
|
||||
[def __std_result_of__ [@https://en.cppreference.com/w/cpp/types/result_of `std::result_of`]]
|
||||
[def __std_sort__ [@https://en.cppreference.com/w/cpp/algorithm/sort `std::sort`]]
|
||||
[def __std_streambuf__ [@https://en.cppreference.com/w/cpp/header/streambuf `std::streambuf`]]
|
||||
[def __std_string__ [@https://en.cppreference.com/w/cpp/string/basic_string `std::string`]]
|
||||
[def __std_string_view__ [@https://en.cppreference.com/w/cpp/string/basic_string_view `std::string_view`]]
|
||||
[def __std_unary_function__ [@https://en.cppreference.com/w/cpp/utility/functional/unary_function `std::unary_function`]]
|
||||
[def __std_unordered_map__ [@https://en.cppreference.com/w/cpp/container/unordered_map `std::unordered_map`]]
|
||||
[def __std_uses_allocator__ [@https://en.cppreference.com/w/cpp/memory/uses_allocator `std::uses_allocator`]]
|
||||
[def __std_vector__ [@https://en.cppreference.com/w/cpp/container/vector `std::vector`]]
|
||||
|
||||
[/ Dingbats ]
|
||||
|
||||
[def __good__ [role green \u2714]]
|
||||
[def __bad__ [role red \u2718]]
|
||||
|
||||
[/-----------------------------------------------------------------------------]
|
||||
|
||||
[include overview.qbk]
|
||||
|
||||
[include utilities.qbk]
|
||||
|
||||
[include other.qbk]
|
||||
|
||||
[section:index_and_ref Indexes and Reference]
|
||||
|
||||
* [link sec:reference Reference]
|
||||
* [link utility.index Index]
|
||||
|
||||
[#sec:reference]
|
||||
[section:ref Reference]
|
||||
[xinclude quickref.xml]
|
||||
[include reference.qbk]
|
||||
[endsect]
|
||||
[xinclude index.xml]
|
||||
[endsect]
|
||||
30
doc/other.qbk
Normal file
30
doc/other.qbk
Normal file
@ -0,0 +1,30 @@
|
||||
[/
|
||||
Copyright (c) 2021 Alan de Freitas (alandefreitas@gmail.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)
|
||||
|
||||
Official repository: https://github.com/boostorg/utility
|
||||
]
|
||||
|
||||
[section:utilities More Utilities]
|
||||
|
||||
Some utilities have been moved from Boost.Utilities to more appropriate Boost libraries:
|
||||
|
||||
# Moved to [@boost:/doc/html/core/index.html Boost.Core]
|
||||
# [@boost:/doc/html/core/doc/html/core/addressof.html addressof]
|
||||
# [@boost:/doc/html/core/doc/html/core/checked_delete.html checked_delete]
|
||||
# [@boost:/doc/html/core/doc/html/core/enable_if.html enable_if]
|
||||
# [@boost:/doc/html/core/doc/html/core/noncopyable.html noncopyable]
|
||||
# Moved to [@boost:/doc/html/type_traits/index.html Boost.TypeTraits]
|
||||
# [@boost:/doc/html/type_traits/doc/html/boost_typetraits/reference/declval.html declval]
|
||||
# Moved to [@boost:/doc/html/iterator/index.html Boost.Iterator]
|
||||
# [@boost:/doc/html/iterator/doc/generator_iterator.htm generator iterator adaptors]
|
||||
# [@boost:/doc/html/iterator/doc/html/iterator/algorithms/next_prior.html next/prior]
|
||||
# Moved to [@boost:/doc/html/io/index.html Boost.IO]
|
||||
# [@boost:/doc/html/io/doc/html/io.html ostream_string]
|
||||
# Moved to [@boost:/doc/html/throw_exception/index.html Boost.ThrowException]
|
||||
# [@boost:/doc/html/throw_exception/doc/html/throw_exception.html#using_boost_throw_exception throw_exception]
|
||||
|
||||
[endsect]
|
||||
|
||||
46
doc/overview.qbk
Normal file
46
doc/overview.qbk
Normal file
@ -0,0 +1,46 @@
|
||||
[/
|
||||
Copyright (c) 2021 Alan de Freitas (alandefreitas@gmail.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)
|
||||
|
||||
Official repository: https://github.com/boostorg/utility
|
||||
]
|
||||
|
||||
[section Overview]
|
||||
[block'''<?dbhtml stop-chunking?>''']
|
||||
|
||||
Boost.Utility is a collection of small, useful, and general-purpose components for language support.
|
||||
|
||||
Over time,
|
||||
|
||||
* several components have been moved to more appropriate Boost libraries and
|
||||
* many of these components had variants accepted into the C++ standard
|
||||
|
||||
When the component has moved to another Boost library, Boost.Utility headers still lead to the appropriate headers
|
||||
in other libraries.
|
||||
|
||||
[table:id Components
|
||||
[[Boost.Utility] [Moved to Boost] [C++ Standard variant]]
|
||||
[[[@boost:/doc/html/core/doc/html/core/addressof.html `addressof`]] [[@boost:/doc/html/core/index.html Boost.Core]] [C++11 __std_addressof__]]
|
||||
[[__base_from_member__] [] []]
|
||||
[[__BOOST_BINARY__] [] [C++14 [@https://en.cppreference.com/w/cpp/language/integer_literal Binary integer literal]]]
|
||||
[[__call_traits__] [] []]
|
||||
[[[@boost:/doc/html/core/doc/html/core/checked_delete.html `checked_delete`]] [[@boost:/doc/html/core/index.html Boost.Core]] []]
|
||||
[[__compressed_pair__] [] []]
|
||||
[[[@boost:/doc/html/type_traits/doc/html/boost_typetraits/reference/declval.html `declval`]] [[@boost:/doc/html/type_traits/index.html Boost.TypeTraits]] [C++11 __std_declval__]]
|
||||
[[[@boost:/doc/html/core/doc/html/core/enable_if.html `enable_if`]] [[@boost:/doc/html/core/index.html Boost.Core]] [C++11 __std_enable_if__]]
|
||||
[[[@boost:/doc/html/iterator/doc/generator_iterator.htm generator iterator adaptors]] [[@boost:/doc/html/iterator/index.html Boost.Iterator]] []]
|
||||
[[__in_place_factory__] [] []]
|
||||
[[[@boost:/doc/html/iterator/index.html `iterator_adaptors`]] [[@boost:/doc/html/iterator/index.html Boost.Iterator]] []]
|
||||
[[[@boost:/doc/html/iterator/doc/html/iterator/algorithms/next_prior.html `next` / `prior`]] [[@boost:/doc/html/iterator/index.html Boost.Iterator]] [C++11 __std_next__ / __std_prev__]]
|
||||
[[[@boost:/doc/html/core/doc/html/core/noncopyable.html `noncopyable`]] [[@boost:/doc/html/core/index.html Boost.Core]] []]
|
||||
[[[link sec:operators `operators`]] [] []]
|
||||
[[[@boost:/doc/html/io/doc/html/io.html `ostream_string`]] [[@boost:/doc/html/io/index.html Boost.IO]] []]
|
||||
[[__result_of__] [] [C++11 __std_result_of__]]
|
||||
[[__string_view__] [] [C++17 __std_string_view__]]
|
||||
[[[@boost:/doc/html/throw_exception/doc/html/throw_exception.html#using_boost_throw_exception `throw_exception`]] [[@boost:/doc/html/throw_exception/index.html Boost.ThrowException]] []]
|
||||
[[[link sec:value_init `value_init`]] [] [C++11 [@https://en.cppreference.com/w/cpp/language/list_initialization List initialization]]]
|
||||
]
|
||||
|
||||
[endsect]
|
||||
35
doc/utilities.qbk
Normal file
35
doc/utilities.qbk
Normal file
@ -0,0 +1,35 @@
|
||||
[/
|
||||
Copyright (c) 2021 Alan de Freitas (alandefreitas@gmail.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)
|
||||
|
||||
Official repository: https://github.com/boostorg/utility
|
||||
]
|
||||
|
||||
[section:utilities Utilities]
|
||||
|
||||
The entire contents of Boost.Utility are in `namespace boost`.
|
||||
|
||||
[warning
|
||||
|
||||
Direct use of the header [@../../../include/boost/utility.hpp `<boost/utility.hpp>`] is discouraged and it will be deprecated.
|
||||
|
||||
Please include the headers relative to individual components instead.
|
||||
|
||||
]
|
||||
|
||||
|
||||
|
||||
[include base_from_member.qbk]
|
||||
[include BOOST_BINARY.qbk]
|
||||
[include call_traits.qbk]
|
||||
[include compressed_pair.qbk]
|
||||
[include in_place_factory.qbk]
|
||||
[include operators.qbk]
|
||||
[include result_of.qbk]
|
||||
[include string_view.qbk]
|
||||
[include value_init.qbk]
|
||||
|
||||
[endsect]
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user