diff options
Diffstat (limited to '3rdparty/sol2/Catch/docs/logging.md')
-rw-r--r-- | 3rdparty/sol2/Catch/docs/logging.md | 52 |
1 files changed, 0 insertions, 52 deletions
diff --git a/3rdparty/sol2/Catch/docs/logging.md b/3rdparty/sol2/Catch/docs/logging.md deleted file mode 100644 index a659b3e8e81..00000000000 --- a/3rdparty/sol2/Catch/docs/logging.md +++ /dev/null @@ -1,52 +0,0 @@ -# Logging macros - -Additional messages can be logged during a test case. - -## Streaming macros - -All these macros allow heterogenous sequences of values to be streaming using the insertion operator (```<<```) in the same way that std::ostream, std::cout, etc support it. - -E.g.: -```c++ -INFO( "The number is " << i ); -``` - -(Note that there is no initial ```<<``` - instead the insertion sequence is placed in parentheses.) -These macros come in three forms: - -**INFO(** _message expression_ **)** - -The message is logged to a buffer, but only reported with the next assertion that is logged. This allows you to log contextual information in case of failures which is not shown during a successful test run (for the console reporter, without -s). Messages are removed from the buffer at the end of their scope, so may be used, for example, in loops. - -**WARN(** _message expression_ **)** - -The message is always reported but does not fail the test. - -**FAIL(** _message expression_ **)** - -The message is reported and the test case fails. - -## Quickly capture a variable value - -**CAPTURE(** _expression_ **)** - -Sometimes you just want to log the name and value of a variable. While you can easily do this with the INFO macro, above, as a convenience the CAPTURE macro handles the stringising of the variable name for you (actually it works with any expression, not just variables). - -E.g. -```c++ -CAPTURE( theAnswer ); -``` - -This would log something like: - -<pre>"theAnswer := 42"</pre> - -## Deprecated macros - -**SCOPED_INFO and SCOPED_CAPTURE** - -These macros are now deprecated and are just aliases for INFO and CAPTURE (which were not previously scoped). - ---- - -[Home](Readme.md)
\ No newline at end of file |