From ca17e7fe8addac5c4a54aa8266c84f91edb49afd Mon Sep 17 00:00:00 2001 From: jzmaddock Date: Sat, 31 May 2014 12:10:51 +0100 Subject: [PATCH] Regenerate docs. --- .../boost_config/boost_macro_reference.html | 42 +++++++++++++++++-- doc/html/index.html | 2 +- 2 files changed, 40 insertions(+), 4 deletions(-) diff --git a/doc/html/boost_config/boost_macro_reference.html b/doc/html/boost_config/boost_macro_reference.html index 2f49f1aa..82672fbe 100644 --- a/doc/html/boost_config/boost_macro_reference.html +++ b/doc/html/boost_config/boost_macro_reference.html @@ -3798,7 +3798,7 @@

This macro can be used in place of the inline - keyword to instruct the compiler that a function should always + keyword to instruct the compiler that the function should always be inlined. Overuse of this macro can lead to significant bloat, while good use can increase performance in certain cases, such as computation-intensive code built through generative programming @@ -3832,8 +3832,8 @@

This macro can be used in place of the inline - keyword to instruct the compiler that a function should never be - inlined. One should typically use this macro to mark functions + keyword to instruct the compiler that the function should never + be inlined. One should typically use this macro to mark functions that are unlikely to be called, such as error handling routines.

@@ -3849,6 +3849,42 @@ + +

+ BOOST_NORETURN +

+ + +

+ This macro can be used before the function declaration or definition + to instruct the compiler that the function does not return normally + (i.e. with a return + statement or by leaving the function scope, if the function return + type is void). The + macro can be used to mark functions that always throw exceptions + or terminate the application. Compilers that support this markup + may use this information to specifically organize the code surrounding + calls to this function and suppress warnings about missing return statements in the functions + enclosing such calls. +

+

+ Usage example: +

+
BOOST_NORETURN void on_error_occurred(const char* descr)
+{
+    throw std::runtime_error(descr);
+}
+
+

+

+

+ If the compiler does not support this markup, BOOST_NORETURN + is defined empty and an additional macro BOOST_NO_NORETURN + is defined. +

+ + +

BOOST_LIKELY(X) diff --git a/doc/html/index.html b/doc/html/index.html index 8eaa462b..aa46cfd1 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -951,7 +951,7 @@ - +

Last revised: May 28, 2014 at 15:31:56 GMT

Last revised: May 31, 2014 at 11:09:07 GMT