diff options
| author | Martin Hořeňovský | 2022-03-17 22:14:56 +0100 |
|---|---|---|
| committer | Martin Hořeňovský | 2022-03-18 10:30:48 +0100 |
| commit | c1c72c7e05599151ae3b2a052735f4731f716420 (patch) | |
| tree | b3e3403c9018ec7c01b4e3a6e3c6f0bdd88e8c27 /src/catch2 | |
| parent | 06092f727d271d2128b026db99dc0d5736434481 (diff) | |
| download | catch3-c1c72c7e05599151ae3b2a052735f4731f716420.tar.gz | |
Better doccomment for IEventListener
Diffstat (limited to 'src/catch2')
| -rw-r--r-- | src/catch2/interfaces/catch_interfaces_reporter.hpp | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/src/catch2/interfaces/catch_interfaces_reporter.hpp b/src/catch2/interfaces/catch_interfaces_reporter.hpp index 41cf426b..53d5ae60 100644 --- a/src/catch2/interfaces/catch_interfaces_reporter.hpp +++ b/src/catch2/interfaces/catch_interfaces_reporter.hpp @@ -150,7 +150,18 @@ namespace Catch { bool shouldReportAllAssertions = false; }; - //! The common base for all reporters and event listeners + /** + * The common base for all reporters and event listeners + * + * Implementing classes must also implement: + * + * //! User-friendly description of the reporter/listener type + * static std::string getDescription() + * + * Generally shouldn't be derived from by users of Catch2 directly, + * instead they should derive from one of the utility bases that + * derive from this class. + */ class IEventListener { protected: //! Derived classes can set up their preferences here |