RuntimeDataDescriber: document that this is a sealed interface

This commit is contained in:
Dylan K. Taylor 2023-07-04 15:55:55 +01:00
parent 6a80b210d4
commit a34514c6a1
No known key found for this signature in database
GPG Key ID: 8927471A91CAFD3D

View File

@ -27,6 +27,14 @@ use pocketmine\block\utils\BrewingStandSlot;
use pocketmine\block\utils\WallConnectionType;
use pocketmine\math\Facing;
/**
* Interface implemented by {@link RuntimeDataReader}, {@link RuntimeDataWriter} and {@link RuntimeDataSizeCalculator}.
* Used to describe the structure of runtime data to an implementation.
*
* This interface should be considered **sealed**.
* You may use it as a type for parameters and return values, but it should not be implemented outside of this package.
* New methods may be added without warning.
*/
interface RuntimeDataDescriber extends RuntimeEnumDescriber{
public function int(int $bits, int &$value) : void;