diff --git a/doc/core.qbk b/doc/core.qbk index a270382..23e47a5 100644 --- a/doc/core.qbk +++ b/doc/core.qbk @@ -52,6 +52,7 @@ criteria for inclusion is that the utility component be: [include noncopyable.qbk] [include null_deleter.qbk] [include pointer_traits.qbk] +[include quick_exit.qbk] [include ref.qbk] [include scoped_enum.qbk] [include swap.qbk] diff --git a/doc/quick_exit.qbk b/doc/quick_exit.qbk new file mode 100644 index 0000000..96d876d --- /dev/null +++ b/doc/quick_exit.qbk @@ -0,0 +1,40 @@ +[/ + Copyright 2018 Peter Dimov + + 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 +] + +[section:quick_exit quick_exit] + +[simplesect Authors] + +* Peter Dimov + +[endsimplesect] + +[section Header ] + +The header `` defines the function +`void boost::quick_exit(int code)`. It calls the standard C++11 function +[@https://en.cppreference.com/w/cpp/utility/program/quick_exit + `std::quick_exit(code)`], if that is available, and otherwise exits the + process via [@https://en.cppreference.com/w/cpp/utility/program/_Exit + `std::_Exit(code)`] or equivalent. + +[section Synopsis] + +`` +namespace boost +{ + [[noreturn]] void quick_exit(int code) noexcept; +} +`` + +[endsect] + +[endsect] + +[endsect]