Document boost/core/max_align.hpp

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]
 

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]

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 <boost/core/max_align.hpp>]
+
+The header `<boost/core/max_align.hpp>` 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]