Document BOOST_CORE_ALIGNOF

This commit is contained in:
Peter Dimov
2023-01-26 03:01:01 +02:00
parent a504b356d4
commit f6193acbdf
3 changed files with 35 additions and 0 deletions

33
doc/alignof.qbk Normal file
View File

@ -0,0 +1,33 @@
[/
Copyright 2023 Peter Dimov
Distributed under the Boost Software License, Version 1.0.
https://boost.org/LICENSE_1_0.txt
]
[section:alignof alignof]
[simplesect Authors]
* Peter Dimov
[endsimplesect]
[section Header <boost/core/alignof.hpp>]
The header `<boost/core/alignof.hpp>` defines the macro `BOOST_CORE_ALIGNOF`,
a portable equivalent of the `alignof` operator from C++11.
[section Example]
``
#include <boost/core/alignof.hpp>
#include <cstddef>
constexpr std::size_t alignment_of_double = BOOST_CORE_ALIGNOF(double);
``
[endsect]
[endsect]
[endsect]

View File

@ -17,6 +17,7 @@
* Marked `boost::ref` member functions and associated methods with `noexcept`.
* Marked `boost::swap` function with `noexcept`, depending on whether the type supports a non-throwing swap operation.
* Added `boost::core::launder`, a portable implementation of `std::launder`.
* Added `BOOST_CORE_ALIGNOF`, a portable implementation of `alignof`.
[endsect]

View File

@ -41,6 +41,7 @@ criteria for inclusion is that the utility component be:
[include changes.qbk]
[include addressof.qbk]
[include alignof.qbk]
[include allocator_access.qbk]
[include allocator_traits.qbk]
[include bit.qbk]