mirror of
https://github.com/catchorg/Catch2.git
synced 2024-12-23 03:43:28 +01:00
Better doccomment for IEventListener
This commit is contained in:
parent
06092f727d
commit
c1c72c7e05
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user