Better doccomment for IEventListener

This commit is contained in:
Martin Hořeňovský 2022-03-17 22:14:56 +01:00
parent 06092f727d
commit c1c72c7e05
No known key found for this signature in database
GPG Key ID: DE48307B8B0D381A
1 changed files with 12 additions and 1 deletions

View File

@ -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