Improved documentation for CancellableTrait

This commit is contained in:
SOFe 2020-09-10 16:48:52 +08:00
parent c20ac82fe6
commit 9d0ac297bb
No known key found for this signature in database
GPG Key ID: BBFD8AF45CA223E6

View File

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