Document implementation of listeners in non-main files

Closes #991
This commit is contained in:
Martin Hořeňovský
2017-08-17 22:29:04 +02:00
parent 626b1d3936
commit 3dc4de8173
2 changed files with 12 additions and 3 deletions

View File

@@ -12,10 +12,11 @@ so you are not forced to implement events you're not interested in.
## Implementing a Listener
Simply derive a class from `Catch::TestEventListenerBase` and implement the methods you are interested in, either in
the main source file (i.e. the one that defines `CATCH_CONFIG_MAIN` or `CATCH_CONFIG_RUNNER`), or in a
file that defines `CATCH_CONFIG_EXTERNAL_INTERFACES`.
In your main source file (i.e. the one that has the `#define` for `CATCH_CONFIG_MAIN` or `CATCH_CONFIG_RUNNER`),
simply derive a class from `Catch::TestEventListenerBase` and implement the methods you are interested in.
Then register it using `INTERNAL_CATCH_REGISTER_LISTENER`.
Then register it using `CATCH_REGISTER_LISTENER`.
For example: