From cc990d571e762b82e1ebebad82985ba2000060af Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Fri, 4 Feb 2022 06:08:20 +0200 Subject: [PATCH] Update BOOST_CURRENT_FUNCTION documentation; closes #23 --- doc/current_function.adoc | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/current_function.adoc b/doc/current_function.adoc index 21453a2..b65f6d6 100644 --- a/doc/current_function.adoc +++ b/doc/current_function.adoc @@ -18,9 +18,10 @@ http://www.boost.org/LICENSE_1_0.txt The header `` defines a single macro, `BOOST_CURRENT_FUNCTION`, similar to the C99 predefined identifier `\\__func__`. -`BOOST_CURRENT_FUNCTION` expands to a string literal containing -the (fully qualified, if possible) name of the enclosing function. If there is -no enclosing function, the behavior is unspecified. +`BOOST_CURRENT_FUNCTION` expands to either a string literal, or the name of a +character array local to the current function, containing the (fully qualified, +if possible) name of the enclosing function. If there is no enclosing function, +the behavior varies by compiler, but is usually a compile error. Some compilers do not provide a way to obtain the name of the current enclosing function. On such compilers, or when the macro `BOOST_DISABLE_CURRENT_FUNCTION`