From c704d8b63010a43154319064d81b7706fcf2bbea Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Wed, 25 Jan 2023 19:02:03 +0200 Subject: [PATCH] Document boost/core/max_align.hpp --- doc/changes.qbk | 2 ++ doc/core.qbk | 1 + doc/max_align.qbk | 42 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 45 insertions(+) create mode 100644 doc/max_align.qbk diff --git a/doc/changes.qbk b/doc/changes.qbk index b77108a..a519e42 100644 --- a/doc/changes.qbk +++ b/doc/changes.qbk @@ -17,6 +17,8 @@ * 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::max_align_t`, a portable equivalent of `std::max_align_t`, and `boost::core::max_align`, the + alignment of `max_align_t`. [endsect] diff --git a/doc/core.qbk b/doc/core.qbk index 54b7b66..6f3685e 100644 --- a/doc/core.qbk +++ b/doc/core.qbk @@ -57,6 +57,7 @@ criteria for inclusion is that the utility component be: [include is_same.qbk] [include launder.qbk] [include lightweight_test.qbk] +[include max_align.qbk] [include no_exceptions_support.qbk] [include noinit_adaptor.qbk] [include noncopyable.qbk] diff --git a/doc/max_align.qbk b/doc/max_align.qbk new file mode 100644 index 0000000..883a260 --- /dev/null +++ b/doc/max_align.qbk @@ -0,0 +1,42 @@ +[/ + Copyright 2023 Peter Dimov + Distributed under the Boost Software License, Version 1.0. + https://boost.org/LICENSE_1_0.txt +] + +[section:max_align max_align] + +[simplesect Authors] + +* Peter Dimov + +[endsimplesect] + +[section Header ] + +The header `` defines the type +`boost::core::max_align_t`, a portable equivalent of +`std::max_align_t`, and the constant `boost::core::max_align`, +the alignment of `max_align_t`. + +[section Synopsis] + +`` +namespace boost +{ +namespace core +{ + +union max_align_t; + +constexpr max_align = alignof(max_align_t); + +} // namespace core +} // namespace boost +`` + +[endsect] + +[endsect] + +[endsect]