phpdoc armageddon for master, pass 1

This commit is contained in:
Dylan K. Taylor
2020-01-22 11:55:03 +00:00
parent 4bae3baa74
commit 67bcc1c0fb
397 changed files with 0 additions and 5391 deletions

View File

@ -51,10 +51,6 @@ class Flat extends Generator{
private $preset;
/**
* @param ChunkManager $world
* @param int $seed
* @param array $options
*
* @throws InvalidGeneratorOptionsException
*/
public function __construct(ChunkManager $world, int $seed, array $options = []){
@ -88,8 +84,6 @@ class Flat extends Generator{
}
/**
* @param string $layers
*
* @return int[]
* @throws InvalidGeneratorOptionsException
*/

View File

@ -35,10 +35,6 @@ abstract class Generator{
/**
* Converts a string world seed into an integer for use by the generator.
*
* @param string $seed
*
* @return int|null
*/
public static function convertSeed(string $seed) : ?int{
if($seed === ""){ //empty seed should cause a random seed to be selected - can't use 0 here because 0 is a valid seed
@ -63,10 +59,6 @@ abstract class Generator{
protected $random;
/**
* @param ChunkManager $world
* @param int $seed
* @param array $options
*
* @throws InvalidGeneratorOptionsException
*/
public function __construct(ChunkManager $world, int $seed, array $options = []){

View File

@ -73,7 +73,6 @@ final class GeneratorManager{
/**
* Returns a class name of a registered Generator matching the given name.
*
* @param string $name
* @param bool $throwOnMissing @deprecated this is for backwards compatibility only
*
* @return string|Generator Name of class that extends Generator (not an actual Generator object)
@ -95,7 +94,6 @@ final class GeneratorManager{
*
* @param string $class Fully qualified name of class that extends \pocketmine\world\generator\Generator
*
* @return string
* @throws \InvalidArgumentException if the class type cannot be matched to a known alias
*/
public static function getGeneratorName(string $class) : string{

View File

@ -45,9 +45,6 @@ abstract class BiomeSelector{
/**
* Lookup function called by recalculate() to determine the biome to use for this temperature and rainfall.
*
* @param float $temperature
* @param float $rainfall
*
* @return int biome ID 0-255
*/
abstract protected function lookup(float $temperature, float $rainfall) : int;
@ -89,8 +86,6 @@ abstract class BiomeSelector{
/**
* @param int $x
* @param int $z
*
* @return Biome
*/
public function pickBiome($x, $z) : Biome{
$temperature = (int) ($this->getTemperature($x, $z) * 63);

View File

@ -51,10 +51,6 @@ class Nether extends Generator{
private $noiseBase;
/**
* @param ChunkManager $world
* @param int $seed
* @param array $options
*
* @throws InvalidGeneratorOptionsException
*/
public function __construct(ChunkManager $world, int $seed, array $options = []){

View File

@ -205,16 +205,6 @@ abstract class Noise{
return $result;
}
/**
* @param int $xSize
* @param int $samplingRate
* @param int $x
* @param int $y
* @param int $z
*
* @return \SplFixedArray
*/
public function getFastNoise1D(int $xSize, int $samplingRate, int $x, int $y, int $z) : \SplFixedArray{
if($samplingRate === 0){
throw new \InvalidArgumentException("samplingRate cannot be 0");
@ -239,16 +229,6 @@ abstract class Noise{
return $noiseArray;
}
/**
* @param int $xSize
* @param int $zSize
* @param int $samplingRate
* @param int $x
* @param int $y
* @param int $z
*
* @return \SplFixedArray
*/
public function getFastNoise2D(int $xSize, int $zSize, int $samplingRate, int $x, int $y, int $z) : \SplFixedArray{
assert($samplingRate !== 0, new \InvalidArgumentException("samplingRate cannot be 0"));
@ -285,19 +265,6 @@ abstract class Noise{
return $noiseArray;
}
/**
* @param int $xSize
* @param int $ySize
* @param int $zSize
* @param int $xSamplingRate
* @param int $ySamplingRate
* @param int $zSamplingRate
* @param int $x
* @param int $y
* @param int $z
*
* @return array
*/
public function getFastNoise3D(int $xSize, int $ySize, int $zSize, int $xSamplingRate, int $ySamplingRate, int $zSamplingRate, int $x, int $y, int $z) : array{
assert($xSamplingRate !== 0, new \InvalidArgumentException("xSamplingRate cannot be 0"));

View File

@ -58,10 +58,6 @@ class Normal extends Generator{
private static $SMOOTH_SIZE = 2;
/**
* @param ChunkManager $world
* @param int $seed
* @param array $options
*
* @throws InvalidGeneratorOptionsException
*/
public function __construct(ChunkManager $world, int $seed, array $options = []){

View File

@ -50,11 +50,6 @@ abstract class Tree{
}
/**
* @param ChunkManager $world
* @param int $x
* @param int $y
* @param int $z
* @param Random $random
* @param TreeType|null $type default oak
*
* @throws \InvalidArgumentException

View File

@ -31,11 +31,5 @@ use pocketmine\world\ChunkManager;
abstract class Populator{
/**
* @param ChunkManager $world
* @param int $chunkX
* @param int $chunkZ
* @param Random $random
*/
abstract public function populate(ChunkManager $world, int $chunkX, int $chunkZ, Random $random) : void;
}