From c1c72c7e05599151ae3b2a052735f4731f716420 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Ho=C5=99e=C5=88ovsk=C3=BD?= Date: Thu, 17 Mar 2022 22:14:56 +0100 Subject: [PATCH] Better doccomment for IEventListener --- 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