catch3
Progmasoft Catch3: an independently maintained C++17 test framework with a parallel runner, property checks, snapshots and structured results.
Clonegit clone https://git.progmasoft.com/catch3
Better doccomment for IEventListener
- Commit
c1c72c7e05599151ae3b2a052735f4731f716420- Author
- Martin Hořeňovský ·
- Parents
06092f727d27
Changes
src/catch2/interfaces/catch_interfaces_reporter.hpp | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) 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