From 9d0ac297bbeb4b9a4330685b24c4045f7fb0c5e9 Mon Sep 17 00:00:00 2001 From: SOFe Date: Thu, 10 Sep 2020 16:48:52 +0800 Subject: [PATCH] Improved documentation for `CancellableTrait` --- src/event/CancellableTrait.php | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/event/CancellableTrait.php b/src/event/CancellableTrait.php index 0fe5186ed..c4eae4290 100644 --- a/src/event/CancellableTrait.php +++ b/src/event/CancellableTrait.php @@ -24,7 +24,11 @@ declare(strict_types=1); namespace pocketmine\event; /** - * This trait implements Cancellable components for events. + * This trait provides a basic boolean-setter-style implementation for `Cancellable` to reduce boilerplate. + * The precise meaning of `setCancelled` is subject to definition by the class using this trait. + * + * Implementors of `Cancellable` are not required to use this trait. + * * @see Cancellable */ trait CancellableTrait{