Skip to content
This repository was archived by the owner on Feb 8, 2019. It is now read-only.

Commit 6845ed0

Browse files
committed
Update PHPDocs
1 parent e4d519c commit 6845ed0

File tree

6 files changed

+40
-0
lines changed

6 files changed

+40
-0
lines changed

src/VectorNetworkProject/TheMix/command/PingCommand.php

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,24 @@
1616

1717
class PingCommand extends PluginCommand
1818
{
19+
/**
20+
* PingCommand constructor.
21+
* @param Plugin $owner
22+
*/
1923
public function __construct(Plugin $owner)
2024
{
2125
parent::__construct('ping', $owner);
2226
$this->setDescription('応答速度を計測します。');
2327
$this->setPermission('the.mix.command.ping');
2428
}
2529

30+
/**
31+
* @param CommandSender $sender
32+
* @param string $commandLabel
33+
* @param array $args
34+
*
35+
* @return bool
36+
*/
2637
public function execute(CommandSender $sender, string $commandLabel, array $args): bool
2738
{
2839
if (!$sender instanceof Player) {

src/VectorNetworkProject/TheMix/command/TpsCommand.php

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,24 @@
1616

1717
class TpsCommand extends PluginCommand
1818
{
19+
/**
20+
* TpsCommand constructor.
21+
* @param Plugin $owner
22+
*/
1923
public function __construct(Plugin $owner)
2024
{
2125
parent::__construct('tps', $owner);
2226
$this->setPermission('the.mix.command.tps');
2327
$this->setDescription('TicksPerSecond');
2428
}
2529

30+
/**
31+
* @param CommandSender $sender
32+
* @param string $commandLabel
33+
* @param array $args
34+
*
35+
* @return bool
36+
*/
2637
public function execute(CommandSender $sender, string $commandLabel, array $args): bool
2738
{
2839
$sender->sendMessage(TextFormat::GREEN.'TPS: '.Server::getInstance()->getTicksPerSecond().'/20');

src/VectorNetworkProject/TheMix/lib/database/Provider.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212

1313
abstract class Provider
1414
{
15+
/**
16+
* @param string $folder
17+
* @param string $type
18+
*
19+
* @return string
20+
*/
1521
protected static function getPath(string $folder, string $type): string
1622
{
1723
return TheMix::getInstance()->getDataFolder().'/'.$folder.'/'.$type.'/';

src/VectorNetworkProject/TheMix/provider/JSON.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ public function deleteTable(): void
7373
/**
7474
* @param string $key
7575
* @param bool|mixed $data
76+
*
77+
* @return void
7678
*/
7779
public function set(string $key, $data): void
7880
{

src/VectorNetworkProject/TheMix/provider/YAML.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ public function deleteTable(): bool
6565
/**
6666
* @param string $key
6767
* @param bool|mixed $data
68+
*
69+
* @return void
6870
*/
6971
public function set(string $key, $data): void
7072
{

src/VectorNetworkProject/TheMix/task/UpdateScoreboardTask.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,20 @@ class UpdateScoreboardTask extends Task
2020
/* @var Player $player */
2121
private $player;
2222

23+
/**
24+
* UpdateScoreboardTask constructor.
25+
* @param Scoreboard $scoreboard
26+
* @param Player $player
27+
*/
2328
public function __construct(Scoreboard $scoreboard, Player $player)
2429
{
2530
$this->scoreboard = $scoreboard;
2631
$this->player = $player;
2732
}
2833

34+
/**
35+
* @param int $currentTick
36+
*/
2937
public function onRun(int $currentTick)
3038
{
3139
if (!$this->player->isOnline()) {

0 commit comments

Comments
 (0)