Expanded logging documentation

Closes #884
This commit is contained in:
Martin Hořeňovský 2017-05-16 14:34:20 +02:00
parent 3dcc923351
commit 1ea84cb734

View File

@ -1,6 +1,32 @@
# Logging macros # Logging macros
Additional messages can be logged during a test case. Additional messages can be logged during a test case. Note that the messages are scoped and thus will not be reported if failure occurs in scope preceding the message declaration. An example:
```cpp
TEST_CASE("Foo") {
INFO("Test case start");
for (int i = 0; i < 2; ++i) {
INFO("The number is " << i);
CHECK(i == 0);
}
}
TEST_CASE("Bar") {
INFO("Test case start");
for (int i = 0; i < 2; ++i) {
INFO("The number is " << i);
CHECK(i == i);
}
CHECK(false);
}
```
When the `CHECK` fails in the "Foo" test case, then two messages will be printed.
```
Test case start
The number is 1
```
When the last `CHECK` fails in the "Bar" test case, then only one message will be printed: `Test case start`.
## Streaming macros ## Streaming macros