core/doc/core.qbk
2014-06-04 21:43:47 -07:00

104 lines
2.4 KiB
Plaintext

[/
Copyright (c) 2014 Glen Joseph Fernandes
glenfe at live dot com
Distributed under the Boost Software License,
Version 1.0. (See accompanying file LICENSE_1_0.txt
or copy at http://boost.org/LICENSE_1_0.txt)
]
[library Boost.Core
[quickbook 1.5]
[id core]
[copyright 2014 Peter Dimov]
[copyright 2014 Glen Fernandes]
[copyright 2014 Andrey Semashev]
[dirname core]
[license Distributed under the
[@http://boost.org/LICENSE_1_0.txt Boost Software License,
Version 1.0].
]
]
[section Introduction]
The Boost.Core library is a collection of core utilities. The
criteria for inclusion is that the utility component be:
* simple,
* used by other Boost libraries, and
* not dependent on any other Boost modules except Core
itself, Config, Assert, Static Assert, or Predef.
Currently, the Core library contains:
[table
[[Component][Utilities]]
[
[[link core.addressof addressof]]
[`boost::addressof`]
]
[
[[link core.checked_delete checked_delete]]
[`boost::checked_delete`]
]
[
[[link core.enable_if enable_if]]
[`boost::enable_if`]
]
[
[[link core.explicit_operator_bool explicit_operator_bool]]
[`BOOST_EXPLICIT_OPERATOR_BOOL,
BOOST_EXPLICIT_OPERATOR_BOOL_NOEXCEPT,
BOOST_CONSTEXPR_EXPLICIT_OPERATOR_BOOL`]
]
[
[[link core.ignore_unused ignore_unused]]
[`boost::ignore_unused`]
]
[
[[link core.lightweight_test lightweight_test]]
[`BOOST_TEST, BOOST_ERROR, BOOST_TEST_EQ, BOOST_TEST_NE,
BOOST_TEST_THROWS, boost::report_errors`]
]
[
[[link core.no_exceptions_support no_exceptions_support]]
[`BOOST_TRY, BOOST_CATCH, BOOST_CATCH_END, BOOST_RETHROW`]
]
[
[[link core.noncopyable noncopyable]]
[`boost::noncopyable`]
]
[
[[link core.null_deleter null_deleter]]
[`boost::null_deleter`]
]
[
[[link core.ref ref]]
[`boost::ref`]
]
[
[[link core.scoped_enum scoped_enum]]
[Components for portable declaration of scoped enums.]
]
[
[[link core.swap swap]]
[`boost::swap`]
]
]
[endsect]
[include:core addressof.qbk]
[include:core checked_delete.qbk]
[include:core enable_if.qbk]
[include:core explicit_operator_bool.qbk]
[include:core ignore_unused.qbk]
[include:core lightweight_test.qbk]
[include:core no_exceptions_support.qbk]
[include:core noncopyable.qbk]
[include:core null_deleter.qbk]
[include:core ref.qbk]
[include:core scoped_enum.qbk]
[include:core swap.qbk]