pocketmine root: sweep missing return type information

AltayMix · Jan 19, 2020 · ea935a1 · ea935a1
1 parent e8a5fa8
commit ea935a1
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 2 deletions.
diff --git a/src/pocketmine/Collectable.php b/src/pocketmine/Collectable.php
@@ -32,6 +32,9 @@ public function isGarbage() : bool{
 		return $this->isGarbage;
 	}
 
+	/**
+	 * @return void
+	 */
 	public function setGarbage(){
 		$this->isGarbage = true;
 	}

diff --git a/src/pocketmine/CrashDump.php b/src/pocketmine/CrashDump.php
@@ -137,6 +137,9 @@ public function getPath() : string{
 		return $this->path;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getEncodedData(){
 		return $this->encodedData;
 	}
@@ -345,13 +348,17 @@ private function generalData() : void{
 
 	/**
 	 * @param string $line
+	 *
+	 * @return void
 	 */
 	public function addLine($line = ""){
 		fwrite($this->fp, $line . PHP_EOL);
 	}
 
 	/**
 	 * @param string $str
+	 *
+	 * @return void
 	 */
 	public function add($str){
 		fwrite($this->fp, $str);

diff --git a/src/pocketmine/IPlayer.php b/src/pocketmine/IPlayer.php
@@ -44,6 +44,8 @@ public function isBanned() : bool;
 
 	/**
 	 * @param bool $banned
+	 *
+	 * @return void
 	 */
 	public function setBanned(bool $banned);
 
@@ -54,6 +56,8 @@ public function isWhitelisted() : bool;
 
 	/**
 	 * @param bool $value
+	 *
+	 * @return void
 	 */
 	public function setWhitelisted(bool $value);
 

diff --git a/src/pocketmine/MemoryManager.php b/src/pocketmine/MemoryManager.php
@@ -115,7 +115,7 @@ public function __construct(Server $server){
 		$this->init();
 	}
 
-	private function init(){
+	private function init() : void{
 		$this->memoryLimit = ((int) $this->server->getProperty("memory.main-limit", 0)) * 1024 * 1024;
 
 		$defaultMemory = 1024;
@@ -201,6 +201,8 @@ public function getViewDistance(int $distance) : int{
 	 * @param int  $limit
 	 * @param bool $global
 	 * @param int  $triggerCount
+	 *
+	 * @return void
 	 */
 	public function trigger(int $memory, int $limit, bool $global = false, int $triggerCount = 0){
 		$this->server->getLogger()->debug(sprintf("[Memory Manager] %sLow memory triggered, limit %gMB, using %gMB",
@@ -230,6 +232,8 @@ public function trigger(int $memory, int $limit, bool $global = false, int $trig
 
 	/**
 	 * Called every tick to update the memory manager state.
+	 *
+	 * @return void
 	 */
 	public function check(){
 		Timings::$memoryManagerTimer->startTiming();
@@ -297,6 +301,8 @@ public function triggerGarbageCollector() : int{
 	 * @param string $outputFolder
 	 * @param int    $maxNesting
 	 * @param int    $maxStringSize
+	 *
+	 * @return void
 	 */
 	public function dumpServerMemory(string $outputFolder, int $maxNesting, int $maxStringSize){
 		$this->server->getLogger()->notice("[Dump] After the memory dump is done, the server might crash");
@@ -319,6 +325,7 @@ public function dumpServerMemory(string $outputFolder, int $maxNesting, int $max
 	 * @param int     $maxStringSize
 	 * @param \Logger $logger
 	 *
+	 * @return void
 	 * @throws \ReflectionException
 	 */
 	public static function dumpMemory($startingObject, string $outputFolder, int $maxNesting, int $maxStringSize, \Logger $logger){
@@ -479,7 +486,7 @@ public static function dumpMemory($startingObject, string $outputFolder, int $ma
 	 * @param int      $maxNesting
 	 * @param int      $maxStringSize
 	 */
-	private static function continueDump($from, &$data, array &$objects, array &$refCounts, int $recursion, int $maxNesting, int $maxStringSize){
+	private static function continueDump($from, &$data, array &$objects, array &$refCounts, int $recursion, int $maxNesting, int $maxStringSize) : void{
 		if($maxNesting <= 0){
 			$data = "(error) NESTING LIMIT REACHED";
 			return;

diff --git a/src/pocketmine/OfflinePlayer.php b/src/pocketmine/OfflinePlayer.php
@@ -57,6 +57,9 @@ public function getName() : string{
 		return $this->name;
 	}
 
+	/**
+	 * @return Server
+	 */
 	public function getServer(){
 		return $this->server;
 	}

diff --git a/src/pocketmine/Thread.php b/src/pocketmine/Thread.php
@@ -36,10 +36,18 @@ abstract class Thread extends \Thread{
 	/** @var bool */
 	protected $isKilled = false;
 
+	/**
+	 * @return \ClassLoader|null
+	 */
 	public function getClassLoader(){
 		return $this->classLoader;
 	}
 
+	/**
+	 * @param \ClassLoader|null $loader
+	 *
+	 * @return void
+	 */
 	public function setClassLoader(\ClassLoader $loader = null){
 		$this->composerAutoloaderPath = \pocketmine\COMPOSER_AUTOLOADER_PATH;
 
@@ -55,6 +63,8 @@ public function setClassLoader(\ClassLoader $loader = null){
 	 * WARNING: This method MUST be called from any descendent threads' run() method to make autoloading usable.
 	 * If you do not do this, you will not be able to use new classes that were not loaded when the thread was started
 	 * (unless you are using a custom autoloader).
+	 *
+	 * @return void
 	 */
 	public function registerClassLoader(){
 		if($this->composerAutoloaderPath !== null){
@@ -65,6 +75,11 @@ public function registerClassLoader(){
 		}
 	}
 
+	/**
+	 * @param int|null $options TODO: pthreads bug
+	 *
+	 * @return bool
+	 */
 	public function start(?int $options = \PTHREADS_INHERIT_ALL){
 		ThreadManager::getInstance()->add($this);
 
@@ -76,6 +91,8 @@ public function start(?int $options = \PTHREADS_INHERIT_ALL){
 
 	/**
 	 * Stops the thread using the best way possible. Try to stop it yourself before calling this.
+	 *
+	 * @return void
 	 */
 	public function quit(){
 		$this->isKilled = true;

diff --git a/src/pocketmine/ThreadManager.php b/src/pocketmine/ThreadManager.php
@@ -31,6 +31,9 @@ class ThreadManager extends \Volatile{
 	/** @var ThreadManager */
 	private static $instance = null;
 
+	/**
+	 * @return void
+	 */
 	public static function init(){
 		self::$instance = new ThreadManager();
 	}
@@ -44,6 +47,8 @@ public static function getInstance(){
 
 	/**
 	 * @param Worker|Thread $thread
+	 *
+	 * @return void
 	 */
 	public function add($thread){
 		if($thread instanceof Thread or $thread instanceof Worker){
@@ -53,6 +58,8 @@ public function add($thread){
 
 	/**
 	 * @param Worker|Thread $thread
+	 *
+	 * @return void
 	 */
 	public function remove($thread){
 		if($thread instanceof Thread or $thread instanceof Worker){

diff --git a/src/pocketmine/Worker.php b/src/pocketmine/Worker.php
@@ -36,10 +36,18 @@ abstract class Worker extends \Worker{
 	/** @var bool */
 	protected $isKilled = false;
 
+	/**
+	 * @return \ClassLoader|null
+	 */
 	public function getClassLoader(){
 		return $this->classLoader;
 	}
 
+	/**
+	 * @param \ClassLoader|null $loader
+	 *
+	 * @return void
+	 */
 	public function setClassLoader(\ClassLoader $loader = null){
 		$this->composerAutoloaderPath = \pocketmine\COMPOSER_AUTOLOADER_PATH;
 
@@ -55,6 +63,8 @@ public function setClassLoader(\ClassLoader $loader = null){
 	 * WARNING: This method MUST be called from any descendent threads' run() method to make autoloading usable.
 	 * If you do not do this, you will not be able to use new classes that were not loaded when the thread was started
 	 * (unless you are using a custom autoloader).
+	 *
+	 * @return void
 	 */
 	public function registerClassLoader(){
 		if($this->composerAutoloaderPath !== null){
@@ -65,6 +75,11 @@ public function registerClassLoader(){
 		}
 	}
 
+	/**
+	 * @param int|null $options TODO: pthreads bug
+	 *
+	 * @return bool
+	 */
 	public function start(?int $options = \PTHREADS_INHERIT_ALL){
 		ThreadManager::getInstance()->add($this);
 
@@ -76,6 +91,8 @@ public function start(?int $options = \PTHREADS_INHERIT_ALL){
 
 	/**
 	 * Stops the thread using the best way possible. Try to stop it yourself before calling this.
+	 *
+	 * @return void
 	 */
 	public function quit(){
 		$this->isKilled = true;