From 0c35c167279fc7e443e5b6269a403af4b5ed949d Mon Sep 17 00:00:00 2001 From: "Dylan K. Taylor" Date: Mon, 6 Feb 2017 14:50:05 +0000 Subject: [PATCH] Fix some doc comments --- src/pocketmine/Player.php | 2 +- src/pocketmine/PocketMine.php | 2 +- src/pocketmine/command/CommandExecutor.php | 2 +- src/pocketmine/command/CommandMap.php | 2 +- .../event/block/BlockBreakEvent.php | 2 +- src/pocketmine/level/Level.php | 4 ++-- src/pocketmine/metadata/Metadatable.php | 2 +- src/pocketmine/permission/Permissible.php | 2 +- src/pocketmine/plugin/PluginManager.php | 12 +++++------ src/pocketmine/plugin/RegisteredListener.php | 2 +- src/pocketmine/utils/Config.php | 20 +++++++++---------- 11 files changed, 25 insertions(+), 27 deletions(-) diff --git a/src/pocketmine/Player.php b/src/pocketmine/Player.php index 37f4c8ecd..5cf07e67d 100644 --- a/src/pocketmine/Player.php +++ b/src/pocketmine/Player.php @@ -537,7 +537,7 @@ class Player extends Human implements CommandSender, InventoryHolder, ChunkLoade * @param SourceInterface $interface * @param null $clientID * @param string $ip - * @param integer $port + * @param int $port */ public function __construct(SourceInterface $interface, $clientID, $ip, $port){ $this->interface = $interface; diff --git a/src/pocketmine/PocketMine.php b/src/pocketmine/PocketMine.php index c2a9d01cd..0e1fa6f67 100644 --- a/src/pocketmine/PocketMine.php +++ b/src/pocketmine/PocketMine.php @@ -27,7 +27,7 @@ namespace { case is_array($var): echo str_repeat(" ", $cnt) . "array(" . count($var) . ") {" . PHP_EOL; foreach($var as $key => $value){ - echo str_repeat(" ", $cnt + 1) . "[" . (is_integer($key) ? $key : '"' . $key . '"') . "]=>" . PHP_EOL; + echo str_repeat(" ", $cnt + 1) . "[" . (is_int($key) ? $key : '"' . $key . '"') . "]=>" . PHP_EOL; ++$cnt; safe_var_dump($value); --$cnt; diff --git a/src/pocketmine/command/CommandExecutor.php b/src/pocketmine/command/CommandExecutor.php index 4e7dcabc6..582333eab 100644 --- a/src/pocketmine/command/CommandExecutor.php +++ b/src/pocketmine/command/CommandExecutor.php @@ -30,7 +30,7 @@ interface CommandExecutor{ * @param string $label * @param string[] $args * - * @return boolean + * @return bool */ public function onCommand(CommandSender $sender, Command $command, $label, array $args); diff --git a/src/pocketmine/command/CommandMap.php b/src/pocketmine/command/CommandMap.php index 76823ec9d..1a4be7906 100644 --- a/src/pocketmine/command/CommandMap.php +++ b/src/pocketmine/command/CommandMap.php @@ -41,7 +41,7 @@ interface CommandMap{ * @param CommandSender $sender * @param string $cmdLine * - * @return boolean + * @return bool */ public function dispatch(CommandSender $sender, $cmdLine); diff --git a/src/pocketmine/event/block/BlockBreakEvent.php b/src/pocketmine/event/block/BlockBreakEvent.php index 2f499b7cc..503bd6e05 100644 --- a/src/pocketmine/event/block/BlockBreakEvent.php +++ b/src/pocketmine/event/block/BlockBreakEvent.php @@ -77,7 +77,7 @@ class BlockBreakEvent extends BlockEvent implements Cancellable{ } /** - * @param boolean $instaBreak + * @param bool $instaBreak */ public function setInstaBreak($instaBreak){ $this->instaBreak = (bool) $instaBreak; diff --git a/src/pocketmine/level/Level.php b/src/pocketmine/level/Level.php index 8f6a3e888..8a543ddef 100644 --- a/src/pocketmine/level/Level.php +++ b/src/pocketmine/level/Level.php @@ -1113,7 +1113,7 @@ class Level implements ChunkManager, Metadatable{ /** * @param Entity $entity * @param AxisAlignedBB $bb - * @param boolean $entities + * @param bool $entities * * @return AxisAlignedBB[] */ @@ -1248,7 +1248,7 @@ class Level implements ChunkManager, Metadatable{ * Gets the Block object on the Vector3 location * * @param Vector3 $pos - * @param boolean $cached + * @param bool $cached * * @return Block */ diff --git a/src/pocketmine/metadata/Metadatable.php b/src/pocketmine/metadata/Metadatable.php index 48dd72aa8..3a185031b 100644 --- a/src/pocketmine/metadata/Metadatable.php +++ b/src/pocketmine/metadata/Metadatable.php @@ -51,7 +51,7 @@ interface Metadatable{ * * @param string $metadataKey * - * @return boolean + * @return bool */ public function hasMetadata($metadataKey); diff --git a/src/pocketmine/permission/Permissible.php b/src/pocketmine/permission/Permissible.php index 7b59a2ac0..88f1eba63 100644 --- a/src/pocketmine/permission/Permissible.php +++ b/src/pocketmine/permission/Permissible.php @@ -30,7 +30,7 @@ interface Permissible extends ServerOperator{ * * @param string|Permission $name * - * @return boolean + * @return bool */ public function isPermissionSet($name); diff --git a/src/pocketmine/plugin/PluginManager.php b/src/pocketmine/plugin/PluginManager.php index 945372059..aba41363b 100644 --- a/src/pocketmine/plugin/PluginManager.php +++ b/src/pocketmine/plugin/PluginManager.php @@ -115,7 +115,7 @@ class PluginManager{ /** * @param string $loaderName A PluginLoader class name * - * @return boolean + * @return bool */ public function registerInterface($loaderName){ if(is_subclass_of($loaderName, PluginLoader::class)){ @@ -381,7 +381,7 @@ class PluginManager{ } /** - * @param boolean $op + * @param bool $op * * @return Permission[] */ @@ -422,7 +422,7 @@ class PluginManager{ } /** - * @param boolean $op + * @param bool $op */ private function dirtyPermissibles($op){ foreach($this->getDefaultPermSubscriptions($op) as $p){ @@ -480,7 +480,7 @@ class PluginManager{ } /** - * @param boolean $op + * @param bool $op * @param Permissible $permissible */ public function subscribeToDefaultPerms($op, Permissible $permissible){ @@ -492,7 +492,7 @@ class PluginManager{ } /** - * @param boolean $op + * @param bool $op * @param Permissible $permissible */ public function unsubscribeFromDefaultPerms($op, Permissible $permissible){ @@ -504,7 +504,7 @@ class PluginManager{ } /** - * @param boolean $op + * @param bool $op * * @return Permissible[] */ diff --git a/src/pocketmine/plugin/RegisteredListener.php b/src/pocketmine/plugin/RegisteredListener.php index 92ca81a2a..c42f477f9 100644 --- a/src/pocketmine/plugin/RegisteredListener.php +++ b/src/pocketmine/plugin/RegisteredListener.php @@ -52,7 +52,7 @@ class RegisteredListener{ * @param EventExecutor $executor * @param int $priority * @param Plugin $plugin - * @param boolean $ignoreCancelled + * @param bool $ignoreCancelled * @param TimingsHandler $timings */ public function __construct(Listener $listener, EventExecutor $executor, $priority, Plugin $plugin, $ignoreCancelled, TimingsHandler $timings){ diff --git a/src/pocketmine/utils/Config.php b/src/pocketmine/utils/Config.php index a024bb9f9..24547d989 100644 --- a/src/pocketmine/utils/Config.php +++ b/src/pocketmine/utils/Config.php @@ -26,8 +26,6 @@ use pocketmine\Server; /** - * Class Config - * * Config Class for simple config manipulation of multiple formats. */ class Config{ @@ -48,9 +46,9 @@ class Config{ /** @var string */ private $file; - /** @var boolean */ + /** @var bool */ private $correct = false; - /** @var integer */ + /** @var int */ private $type = Config::DETECT; public static $formats = [ @@ -168,7 +166,7 @@ class Config{ } /** - * @return boolean + * @return bool */ public function check(){ return $this->correct === true; @@ -177,7 +175,7 @@ class Config{ /** * @param bool $async * - * @return boolean + * @return bool */ public function save($async = false){ if($this->correct === true){ @@ -224,7 +222,7 @@ class Config{ /** * @param $k * - * @return boolean|mixed + * @return bool|mixed */ public function __get($k){ return $this->get($k); @@ -241,7 +239,7 @@ class Config{ /** * @param $k * - * @return boolean + * @return bool */ public function __isset($k){ return $this->exists($k); @@ -315,7 +313,7 @@ class Config{ * @param $k * @param mixed $default * - * @return boolean|mixed + * @return bool|mixed */ public function get($k, $default = false){ return ($this->correct and isset($this->config[$k])) ? $this->config[$k] : $default; @@ -345,7 +343,7 @@ class Config{ * @param $k * @param bool $lowercase If set, searches Config in single-case / lowercase. * - * @return boolean + * @return bool */ public function exists($k, $lowercase = false){ if($lowercase === true){ @@ -384,7 +382,7 @@ class Config{ * @param $default * @param $data * - * @return integer + * @return int */ private function fillDefaults($default, &$data){ $changed = 0;