feedc0de/boost_assert
1
0
Fork 0
forked from boostorg/assert
Code Pull Requests Activity

Update BOOST_CURRENT_FUNCTION documentation; closes #23

Browse Source
This commit is contained in:
Peter Dimov
2022-02-04 06:08:20 +02:00
parent 47a44c14c3
commit cc990d571e
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/current_function.adoc
View File

@ -18,9 +18,10 @@ http://www.boost.org/LICENSE_1_0.txt
The header `<boost/current_function.hpp>` 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`