Fixed some unnecessary FQNs in docs

This commit is contained in:
Dylan K. Taylor 2017-06-25 12:43:04 +01:00
parent a365c831a8
commit a73c6f1861
23 changed files with 59 additions and 40 deletions

View File

@ -53,6 +53,7 @@ use pocketmine\item\enchantment\Enchantment;
use pocketmine\item\Item; use pocketmine\item\Item;
use pocketmine\lang\BaseLang; use pocketmine\lang\BaseLang;
use pocketmine\level\format\io\leveldb\LevelDB; use pocketmine\level\format\io\leveldb\LevelDB;
use pocketmine\level\format\io\LevelProvider;
use pocketmine\level\format\io\LevelProviderManager; use pocketmine\level\format\io\LevelProviderManager;
use pocketmine\level\format\io\region\Anvil; use pocketmine\level\format\io\region\Anvil;
use pocketmine\level\format\io\region\McRegion; use pocketmine\level\format\io\region\McRegion;
@ -1047,7 +1048,7 @@ class Server{
try{ try{
$path = $this->getDataPath() . "worlds/" . $name . "/"; $path = $this->getDataPath() . "worlds/" . $name . "/";
/** @var \pocketmine\level\format\io\LevelProvider $provider */ /** @var LevelProvider $provider */
$provider::generate($path, $name, $seed, $generator, $options); $provider::generate($path, $name, $seed, $generator, $options);
$level = new Level($this, $name, $path, (string) $provider); $level = new Level($this, $name, $path, (string) $provider);

View File

@ -25,6 +25,7 @@ namespace pocketmine\command;
use pocketmine\event\TextContainer; use pocketmine\event\TextContainer;
use pocketmine\permission\Permissible; use pocketmine\permission\Permissible;
use pocketmine\Server;
interface CommandSender extends Permissible{ interface CommandSender extends Permissible{
@ -34,7 +35,7 @@ interface CommandSender extends Permissible{
public function sendMessage($message); public function sendMessage($message);
/** /**
* @return \pocketmine\Server * @return Server
*/ */
public function getServer(); public function getServer();

View File

@ -25,7 +25,9 @@ namespace pocketmine\command;
use pocketmine\event\TextContainer; use pocketmine\event\TextContainer;
use pocketmine\permission\PermissibleBase; use pocketmine\permission\PermissibleBase;
use pocketmine\permission\Permission;
use pocketmine\permission\PermissionAttachment; use pocketmine\permission\PermissionAttachment;
use pocketmine\permission\PermissionAttachmentInfo;
use pocketmine\plugin\Plugin; use pocketmine\plugin\Plugin;
use pocketmine\Server; use pocketmine\Server;
use pocketmine\utils\MainLogger; use pocketmine\utils\MainLogger;
@ -39,7 +41,7 @@ class ConsoleCommandSender implements CommandSender{
} }
/** /**
* @param \pocketmine\permission\Permission|string $name * @param Permission|string $name
* *
* @return bool * @return bool
*/ */
@ -48,7 +50,7 @@ class ConsoleCommandSender implements CommandSender{
} }
/** /**
* @param \pocketmine\permission\Permission|string $name * @param Permission|string $name
* *
* @return bool * @return bool
*/ */
@ -61,7 +63,7 @@ class ConsoleCommandSender implements CommandSender{
* @param string $name * @param string $name
* @param bool $value * @param bool $value
* *
* @return \pocketmine\permission\PermissionAttachment * @return PermissionAttachment
*/ */
public function addAttachment(Plugin $plugin, $name = null, $value = null){ public function addAttachment(Plugin $plugin, $name = null, $value = null){
return $this->perm->addAttachment($plugin, $name, $value); return $this->perm->addAttachment($plugin, $name, $value);
@ -81,7 +83,7 @@ class ConsoleCommandSender implements CommandSender{
} }
/** /**
* @return \pocketmine\permission\PermissionAttachmentInfo[] * @return PermissionAttachmentInfo[]
*/ */
public function getEffectivePermissions(){ public function getEffectivePermissions(){
return $this->perm->getEffectivePermissions(); return $this->perm->getEffectivePermissions();
@ -95,7 +97,7 @@ class ConsoleCommandSender implements CommandSender{
} }
/** /**
* @return \pocketmine\Server * @return Server
*/ */
public function getServer(){ public function getServer(){
return Server::getInstance(); return Server::getInstance();

View File

@ -23,10 +23,12 @@ declare(strict_types=1);
namespace pocketmine\command; namespace pocketmine\command;
use pocketmine\plugin\Plugin;
interface PluginIdentifiableCommand{ interface PluginIdentifiableCommand{
/** /**
* @return \pocketmine\plugin\Plugin * @return Plugin
*/ */
public function getPlugin(); public function getPlugin();
} }

View File

@ -36,6 +36,7 @@ use pocketmine\event\entity\EntityRegainHealthEvent;
use pocketmine\event\entity\EntitySpawnEvent; use pocketmine\event\entity\EntitySpawnEvent;
use pocketmine\event\entity\EntityTeleportEvent; use pocketmine\event\entity\EntityTeleportEvent;
use pocketmine\event\Timings; use pocketmine\event\Timings;
use pocketmine\event\TimingsHandler;
use pocketmine\level\format\Chunk; use pocketmine\level\format\Chunk;
use pocketmine\level\Level; use pocketmine\level\Level;
use pocketmine\level\Location; use pocketmine\level\Location;
@ -322,7 +323,7 @@ abstract class Entity extends Location implements Metadatable{
public $closed = false; public $closed = false;
/** @var \pocketmine\event\TimingsHandler */ /** @var TimingsHandler */
protected $timings; protected $timings;
protected $isPlayer = false; protected $isPlayer = false;

View File

@ -31,10 +31,10 @@ use pocketmine\Player;
class BlockBreakEvent extends BlockEvent implements Cancellable{ class BlockBreakEvent extends BlockEvent implements Cancellable{
public static $handlerList = null; public static $handlerList = null;
/** @var \pocketmine\Player */ /** @var Player */
protected $player; protected $player;
/** @var \pocketmine\item\Item */ /** @var Item */
protected $item; protected $item;
/** @var bool */ /** @var bool */

View File

@ -30,7 +30,7 @@ use pocketmine\block\Block;
use pocketmine\event\Event; use pocketmine\event\Event;
abstract class BlockEvent extends Event{ abstract class BlockEvent extends Event{
/** @var \pocketmine\block\Block */ /** @var Block */
protected $block; protected $block;
/** /**

View File

@ -34,10 +34,10 @@ use pocketmine\Player;
class BlockPlaceEvent extends BlockEvent implements Cancellable{ class BlockPlaceEvent extends BlockEvent implements Cancellable{
public static $handlerList = null; public static $handlerList = null;
/** @var \pocketmine\Player */ /** @var Player */
protected $player; protected $player;
/** @var \pocketmine\item\Item */ /** @var Item */
protected $item; protected $item;

View File

@ -33,7 +33,7 @@ use pocketmine\Player;
class SignChangeEvent extends BlockEvent implements Cancellable{ class SignChangeEvent extends BlockEvent implements Cancellable{
public static $handlerList = null; public static $handlerList = null;
/** @var \pocketmine\Player */ /** @var Player */
private $player; private $player;
/** @var string[] */ /** @var string[] */
private $lines = []; private $lines = [];

View File

@ -50,7 +50,7 @@ class EntityDeathEvent extends EntityEvent{
} }
/** /**
* @return \pocketmine\item\Item[] * @return Item[]
*/ */
public function getDrops(){ public function getDrops(){
return $this->drops; return $this->drops;

View File

@ -26,10 +26,11 @@ declare(strict_types=1);
*/ */
namespace pocketmine\event\entity; namespace pocketmine\event\entity;
use pocketmine\entity\Entity;
use pocketmine\event\Event; use pocketmine\event\Event;
abstract class EntityEvent extends Event{ abstract class EntityEvent extends Event{
/** @var \pocketmine\entity\Entity */ /** @var Entity */
protected $entity; protected $entity;
public function getEntity(){ public function getEntity(){

View File

@ -29,6 +29,7 @@ use pocketmine\entity\Human;
use pocketmine\entity\Item; use pocketmine\entity\Item;
use pocketmine\entity\Projectile; use pocketmine\entity\Projectile;
use pocketmine\entity\Vehicle; use pocketmine\entity\Vehicle;
use pocketmine\level\Position;
/** /**
* Called when a entity is spawned * Called when a entity is spawned
@ -48,7 +49,7 @@ class EntitySpawnEvent extends EntityEvent{
} }
/** /**
* @return \pocketmine\level\Position * @return Position
*/ */
public function getPosition(){ public function getPosition(){
return $this->entity->getPosition(); return $this->entity->getPosition();

View File

@ -36,12 +36,12 @@ class CraftItemEvent extends Event implements Cancellable{
private $input = []; private $input = [];
/** @var Recipe */ /** @var Recipe */
private $recipe; private $recipe;
/** @var \pocketmine\Player */ /** @var Player */
private $player; private $player;
/** /**
* @param \pocketmine\Player $player * @param Player $player
* @param Item[] $input * @param Item[] $input
* @param Recipe $recipe * @param Recipe $recipe
*/ */
@ -71,7 +71,7 @@ class CraftItemEvent extends Event implements Cancellable{
} }
/** /**
* @return \pocketmine\Player * @return Player
*/ */
public function getPlayer(){ public function getPlayer(){
return $this->player; return $this->player;

View File

@ -26,6 +26,7 @@ declare(strict_types=1);
*/ */
namespace pocketmine\event\inventory; namespace pocketmine\event\inventory;
use pocketmine\entity\Human;
use pocketmine\event\Event; use pocketmine\event\Event;
use pocketmine\inventory\Inventory; use pocketmine\inventory\Inventory;
@ -46,7 +47,7 @@ abstract class InventoryEvent extends Event{
} }
/** /**
* @return \pocketmine\entity\Human[] * @return Human[]
*/ */
public function getViewers(){ public function getViewers(){
return $this->inventory->getViewers(); return $this->inventory->getViewers();

View File

@ -30,7 +30,7 @@ use pocketmine\event\Event;
use pocketmine\level\Level; use pocketmine\level\Level;
abstract class LevelEvent extends Event{ abstract class LevelEvent extends Event{
/** @var \pocketmine\level\Level */ /** @var Level */
private $level; private $level;
/** /**
@ -41,7 +41,7 @@ abstract class LevelEvent extends Event{
} }
/** /**
* @return \pocketmine\level\Level * @return Level
*/ */
public function getLevel(){ public function getLevel(){
return $this->level; return $this->level;

View File

@ -27,9 +27,10 @@ declare(strict_types=1);
namespace pocketmine\event\player; namespace pocketmine\event\player;
use pocketmine\event\Event; use pocketmine\event\Event;
use pocketmine\Player;
abstract class PlayerEvent extends Event{ abstract class PlayerEvent extends Event{
/** @var \pocketmine\Player */ /** @var Player */
protected $player; protected $player;
public function getPlayer(){ public function getPlayer(){

View File

@ -43,7 +43,7 @@ class PlayerInteractEvent extends PlayerEvent implements Cancellable{
const PHYSICAL = 4; const PHYSICAL = 4;
/** /**
* @var \pocketmine\block\Block; * @var Block
*/ */
protected $blockTouched; protected $blockTouched;
@ -52,7 +52,7 @@ class PlayerInteractEvent extends PlayerEvent implements Cancellable{
/** @var int */ /** @var int */
protected $blockFace; protected $blockFace;
/** @var \pocketmine\item\Item */ /** @var Item */
protected $item; protected $item;
protected $action; protected $action;

View File

@ -23,6 +23,8 @@ declare(strict_types=1);
namespace pocketmine\event\server; namespace pocketmine\event\server;
use pocketmine\Player;
use pocketmine\plugin\Plugin;
use pocketmine\Server; use pocketmine\Server;
use pocketmine\utils\Binary; use pocketmine\utils\Binary;
@ -34,9 +36,9 @@ class QueryRegenerateEvent extends ServerEvent{
private $timeout; private $timeout;
private $serverName; private $serverName;
private $listPlugins; private $listPlugins;
/** @var \pocketmine\plugin\Plugin[] */ /** @var Plugin[] */
private $plugins; private $plugins;
/** @var \pocketmine\Player[] */ /** @var Player[] */
private $players; private $players;
private $gametype; private $gametype;
@ -106,28 +108,28 @@ class QueryRegenerateEvent extends ServerEvent{
} }
/** /**
* @return \pocketmine\plugin\Plugin[] * @return Plugin[]
*/ */
public function getPlugins(){ public function getPlugins(){
return $this->plugins; return $this->plugins;
} }
/** /**
* @param \pocketmine\plugin\Plugin[] $plugins * @param Plugin[] $plugins
*/ */
public function setPlugins(array $plugins){ public function setPlugins(array $plugins){
$this->plugins = $plugins; $this->plugins = $plugins;
} }
/** /**
* @return \pocketmine\Player[] * @return Player[]
*/ */
public function getPlayerList(){ public function getPlayerList(){
return $this->players; return $this->players;
} }
/** /**
* @param \pocketmine\Player[] $players * @param Player[] $players
*/ */
public function setPlayerList(array $players){ public function setPlayerList(array $players){
$this->players = $players; $this->players = $players;

View File

@ -23,12 +23,13 @@ declare(strict_types=1);
namespace pocketmine\inventory; namespace pocketmine\inventory;
use pocketmine\item\Item;
use pocketmine\utils\UUID; use pocketmine\utils\UUID;
interface Recipe{ interface Recipe{
/** /**
* @return \pocketmine\item\Item * @return Item
*/ */
public function getResult(); public function getResult();

View File

@ -27,6 +27,8 @@ declare(strict_types=1);
namespace pocketmine\plugin; namespace pocketmine\plugin;
use pocketmine\command\CommandExecutor; use pocketmine\command\CommandExecutor;
use pocketmine\Server;
use pocketmine\utils\Config;
/** /**
@ -90,7 +92,7 @@ interface Plugin extends CommandExecutor{
public function getResources(); public function getResources();
/** /**
* @return \pocketmine\utils\Config * @return Config
*/ */
public function getConfig(); public function getConfig();
@ -101,7 +103,7 @@ interface Plugin extends CommandExecutor{
public function reloadConfig(); public function reloadConfig();
/** /**
* @return \pocketmine\Server * @return Server
*/ */
public function getServer(); public function getServer();

View File

@ -34,7 +34,7 @@ abstract class PluginBase implements Plugin{
/** @var PluginLoader */ /** @var PluginLoader */
private $loader; private $loader;
/** @var \pocketmine\Server */ /** @var Server */
private $server; private $server;
/** @var bool */ /** @var bool */

View File

@ -24,6 +24,7 @@ declare(strict_types=1);
namespace pocketmine\scheduler; namespace pocketmine\scheduler;
use pocketmine\event\Timings; use pocketmine\event\Timings;
use pocketmine\event\TimingsHandler;
class TaskHandler{ class TaskHandler{
@ -45,7 +46,7 @@ class TaskHandler{
/** @var bool */ /** @var bool */
protected $cancelled = false; protected $cancelled = false;
/** @var \pocketmine\event\TimingsHandler */ /** @var TimingsHandler */
public $timings; public $timings;
public $timingName = null; public $timingName = null;

View File

@ -26,7 +26,9 @@ declare(strict_types=1);
*/ */
namespace pocketmine\tile; namespace pocketmine\tile;
use pocketmine\block\Block;
use pocketmine\event\Timings; use pocketmine\event\Timings;
use pocketmine\event\TimingsHandler;
use pocketmine\level\format\Chunk; use pocketmine\level\format\Chunk;
use pocketmine\level\Level; use pocketmine\level\Level;
use pocketmine\level\Position; use pocketmine\level\Position;
@ -63,7 +65,7 @@ abstract class Tile extends Position{
protected $server; protected $server;
protected $timings; protected $timings;
/** @var \pocketmine\event\TimingsHandler */ /** @var TimingsHandler */
public $tickTimer; public $tickTimer;
public static function init(){ public static function init(){
@ -162,7 +164,7 @@ abstract class Tile extends Position{
} }
/** /**
* @return \pocketmine\block\Block * @return Block
*/ */
public function getBlock(){ public function getBlock(){
return $this->level->getBlock($this); return $this->level->getBlock($this);