3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-11-16 02:32:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs with INFO/ CAPTURE changes

Browse Source
This commit is contained in:
Phil Nash 2013-06-28 17:15:45 +01:00
parent b5fd5a6496
commit d60b248409
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/logging.md
View File

@ -16,15 +16,11 @@ 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).
**SCOPED_INFO(** _message expression_ **)**
As INFO, but is only in effect during the current scope. If a failure occurs beyond the end of the scope the message is not logged. In a looped block the message is reset on each iteration.
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.
The message is always reported but does not fail the test.
**FAIL(** _message expression_ **)**
@ -45,6 +41,12 @@ 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)