Added multiple comments and info

PocketMine-MP.php

@@ -14,7 +14,7 @@
  * (at your option) any later version.
  *
  * @author PocketMine Team
- * @link http://www.pocketmine.net/
+
  * 
  *
 */

src/Achievement.php

@@ -14,7 +14,7 @@
  * (at your option) any later version.
  *
  * @author PocketMine Team
- * @link http://www.pocketmine.net/
+
  * 
  *
 */

src/Server.php

@@ -19,6 +19,10 @@
  *
 */
 
+/**
+ * PocketMine-MP is the Minecraft: PE multiplayer server software
+ * Homepage: http://www.pocketmine.net/
+ */
 namespace PocketMine;
 
 use PocketMine\Entity\Entity as Entity;

src/block/Block.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * All Block classes are in here
+ */
 namespace PocketMine\Block;
 const AIR = 0;
 const STONE = 1;

src/entity/Entity.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * All the entity classes
+ */
 namespace PocketMine\Entity;
 
 use PocketMine\Event\Entity\EntityLevelChangeEvent as EntityLevelChangeEvent;

src/event/Event.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * Classes referenced to Event handling and Events itself
+ */
 namespace PocketMine\Event;
 
 use PocketMine;

src/event/EventPriority.php

@@ -1,6 +1,6 @@
 <?php
 
-/**
+/*
  *
  *  ____            _        _   __  __ _                  __  __ ____
  * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \

src/event/entity/EntityEvent.php

@@ -1,6 +1,6 @@
 <?php
 
-/**
+/*
  *
  *  ____            _        _   __  __ _                  __  __ ____
  * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
@@ -19,6 +19,9 @@
  *
  */
 
+/**
+ * Entity related Events, like spawn, inventory, attack...
+ */
 namespace PocketMine\Event\Entity;
 
 use PocketMine;

src/event/player/PlayerEvent.php

@@ -1,6 +1,6 @@
 <?php
 
-/**
+/*
  *
  *  ____            _        _   __  __ _                  __  __ ____
  * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
@@ -19,6 +19,9 @@
  *
  */
 
+/**
+ * Player-only related events
+ */
 namespace PocketMine\Event\Player;
 
 use PocketMine;

src/event/plugin/PluginEvent.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * Events related Plugin enable / disable events
+ */
 namespace PocketMine\Event\Plugin;
 
 use PocketMine;

src/event/server/ServerEvent.php

@@ -1,6 +1,6 @@
 <?php
 
-/**
+/*
  *
  *  ____            _        _   __  __ _                  __  __ ____
  * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
@@ -19,6 +19,9 @@
  *
  */
 
+/**
+ * Events related to the server core, like networking, stop, level loading
+ */
 namespace PocketMine\Event\Server;
 
 use PocketMine;

src/event/tile/TileEvent.php

@@ -1,6 +1,6 @@
 <?php
 
-/**
+/*
  *
  *  ____            _        _   __  __ _                  __  __ ____
  * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
@@ -19,6 +19,9 @@
  *
  */
 
+/**
+ * Events used by Tiles
+ */
 namespace PocketMine\Event\Tile;
 
 use PocketMine;

src/item/Block.php

@@ -24,6 +24,12 @@ namespace PocketMine\Item;
 use PocketMine;
 use PocketMine\Block\Block as BlockBlock;
 
+/**
+ * Class used for Items that can be Blocks
+ *
+ * Class Block
+ * @package PocketMine\Item
+ */
 class Block extends Item{
 	public function __construct(BlockBlock $block, $meta = 0, $count = 1){
 		$this->block = clone $block;

src/item/Item.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * All the Item classes
+ */
 namespace PocketMine\Item;
 
 //All Block IDs are here too

src/level/Level.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * All Level related classes are here, like Generators, Populators, Noise, ...
+ */
 namespace PocketMine\Level;
 
 use PocketMine\Block\Air as Air;

src/level/generator/Generator.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * Generator classes used in Levels
+ */
 namespace PocketMine\Level\Generator;
 
 use PocketMine\Level\Level as Level;

src/level/generator/noise/Generator.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * Different noise generators for level generation
+ */
 namespace PocketMine\Level\Generator\Noise;
 
 use PocketMine;

src/level/generator/object/Object.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+*/
+
+/**
+ * All the different object classes used in populators
+ */
+namespace PocketMine\Level\Generator\Object;
+use PocketMine;
+
+abstract class Object{
+
+}

src/level/generator/populator/Populator.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * All the Object populator classes
+ */
 namespace PocketMine\Level\Generator\Populator;
 
 use PocketMine\Level\Level as Level;

src/math/AxisAlignedBB.php

@@ -2,11 +2,11 @@
 
 /*
  *
- *  ____            _        _   __  __ _                  __  __ ____  
+ *  ____            _        _   __  __ _                  __  __ ____
- * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \ 
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
  * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
- * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/ 
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
- * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_| 
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -15,12 +15,11 @@
  *
  * @author PocketMine Team
  * @link http://www.pocketmine.net/
- * 
+ *
  *
 */
 
 namespace PocketMine\Math;
-
 use PocketMine;
 
 class AxisAlignedBB{

src/math/Math.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+*/
+
+/**
+ * Math related classes, like matrices, bounding boxes and vector
+ */
+namespace PocketMine\Math;
+use PocketMine;
+
+abstract class Math{
+
+}

src/nbt/NBT.php

@@ -19,9 +19,24 @@
  *
 */
 
+/**
+ * Named Binary Tag handling classes
+ */
 namespace PocketMine\NBT;
 const LITTLE_ENDIAN = 0;
 const BIG_ENDIAN = 1;
+const TAG_End = 0;
+const TAG_Byte = 1;
+const TAG_Short = 2;
+const TAG_Int = 3;
+const TAG_Long = 4;
+const TAG_Float = 5;
+const TAG_Double = 6;
+const TAG_Byte_Array = 7;
+const TAG_String = 8;
+const TAG_Enum = 9;
+const TAG_Compound = 10;
+const TAG_Int_Array = 11;
 use PocketMine\NBT\Tag\Byte as Byte;
 use PocketMine\NBT\Tag\Byte_Array as Byte_Array;
 use PocketMine\NBT\Tag\Compound as Compound;
@@ -145,9 +160,9 @@ class NBT implements \ArrayAccess{
 		return $tag;
 	}
 
-	public function writeTag(NBTTag $tag){
+	public function writeTag(Tag\Tag $tag){
 		$this->putByte($tag->getType());
-		if($tag instanceof NamedNBTTag){
+		if($tag instanceof Tag\NamedTAG){
 			$this->putString($tag->getName());
 		}
 		$tag->write($this);
@@ -162,43 +177,43 @@ class NBT implements \ArrayAccess{
 	}
 
 	public function getShort(){
-		return $this->endianness === self::BIG_ENDIAN ? Utils::readShort($this->get(2)) : Utils::readLShort($this->get(2));
+		return $this->endianness === BIG_ENDIAN ? Utils::readShort($this->get(2)) : Utils::readLShort($this->get(2));
 	}
 
 	public function putShort($v){
-		$this->buffer .= $this->endianness === self::BIG_ENDIAN ? Utils::writeShort($v) : Utils::writeLShort($v);
+		$this->buffer .= $this->endianness === BIG_ENDIAN ? Utils::writeShort($v) : Utils::writeLShort($v);
 	}
 
 	public function getInt(){
-		return $this->endianness === self::BIG_ENDIAN ? Utils::readInt($this->get(4)) : Utils::readLInt($this->get(4));
+		return $this->endianness === BIG_ENDIAN ? Utils::readInt($this->get(4)) : Utils::readLInt($this->get(4));
 	}
 
 	public function putInt($v){
-		$this->buffer .= $this->endianness === self::BIG_ENDIAN ? Utils::writeInt($v) : Utils::writeLInt($v);
+		$this->buffer .= $this->endianness === BIG_ENDIAN ? Utils::writeInt($v) : Utils::writeLInt($v);
 	}
 
 	public function getLong(){
-		return $this->endianness === self::BIG_ENDIAN ? Utils::readLong($this->get(8)) : Utils::readLLong($this->get(8));
+		return $this->endianness === BIG_ENDIAN ? Utils::readLong($this->get(8)) : Utils::readLLong($this->get(8));
 	}
 
 	public function putLong($v){
-		$this->buffer .= $this->endianness === self::BIG_ENDIAN ? Utils::writeLong($v) : Utils::writeLLong($v);
+		$this->buffer .= $this->endianness === BIG_ENDIAN ? Utils::writeLong($v) : Utils::writeLLong($v);
 	}
 
 	public function getFloat(){
-		return $this->endianness === self::BIG_ENDIAN ? Utils::readFloat($this->get(4)) : Utils::readLFloat($this->get(4));
+		return $this->endianness === BIG_ENDIAN ? Utils::readFloat($this->get(4)) : Utils::readLFloat($this->get(4));
 	}
 
 	public function putFloat($v){
-		$this->buffer .= $this->endianness === self::BIG_ENDIAN ? Utils::writeFloat($v) : Utils::writeLFloat($v);
+		$this->buffer .= $this->endianness === BIG_ENDIAN ? Utils::writeFloat($v) : Utils::writeLFloat($v);
 	}
 
 	public function getDouble(){
-		return $this->endianness === self::BIG_ENDIAN ? Utils::readDouble($this->get(8)) : Utils::readLDouble($this->get(8));
+		return $this->endianness === BIG_ENDIAN ? Utils::readDouble($this->get(8)) : Utils::readLDouble($this->get(8));
 	}
 
 	public function putDouble($v){
-		$this->buffer .= $this->endianness === self::BIG_ENDIAN ? Utils::writeDouble($v) : Utils::writeLDouble($v);
+		$this->buffer .= $this->endianness === BIG_ENDIAN ? Utils::writeDouble($v) : Utils::writeLDouble($v);
 	}
 
 	public function getString(){

src/nbt/tag/Byte.php

@@ -24,7 +24,7 @@ namespace PocketMine\NBT\Tag;
 use PocketMine;
 use PocketMine\NBT;
 
-class Byte extends NamedNBTTag{
+class Byte extends NamedTag{
 
 	public function getType(){
 		return NBT\TAG_Byte;

src/nbt/tag/Byte_Array.php

@@ -24,7 +24,7 @@ namespace PocketMine\NBT\Tag;
 use PocketMine;
 use PocketMine\NBT;
 
-class Byte_Array extends NamedNBTTag{
+class Byte_Array extends NamedTag{
 
 	public function getType(){
 		return NBT\TAG_Byte_Array;

src/nbt/tag/Compound.php

@@ -24,7 +24,7 @@ namespace PocketMine\NBT\Tag;
 use PocketMine;
 use PocketMine\NBT;
 
-class Compound extends NamedNBTTag implements \ArrayAccess, \Iterator{
+class Compound extends NamedTag implements \ArrayAccess, \Iterator{
 
 	public function __construct($name = "", $value = array()){
 		$this->name = $name;

src/nbt/tag/Double.php

@@ -24,7 +24,7 @@ namespace PocketMine\NBT\Tag;
 use PocketMine;
 use PocketMine\NBT;
 
-class Double extends NamedNBTTag{
+class Double extends NamedTag{
 
 	public function getType(){
 		return NBT\TAG_Double;

src/nbt/tag/End.php

@@ -24,7 +24,7 @@ namespace PocketMine\NBT\Tag;
 use PocketMine;
 use PocketMine\NBT;
 
-class End extends NBTTag{
+class End extends Tag{
 
 	public function getType(){
 		return NBT\TAG_End;

src/nbt/tag/Enum.php

@@ -25,7 +25,7 @@ use PocketMine\NBT\Tag\Enum as TagEnum;
 use PocketMine;
 use PocketMine\NBT;
 
-class Enum extends NamedNBTTag implements \ArrayAccess, \Iterator{
+class Enum extends NamedTag implements \ArrayAccess, \Iterator{
 
 	private $tagType;
 

src/nbt/tag/Float.php

@@ -24,7 +24,7 @@ namespace PocketMine\NBT\Tag;
 use PocketMine;
 use PocketMine\NBT;
 
-class Float extends NamedNBTTag{
+class Float extends NamedTag{
 
 	public function getType(){
 		return NBT\TAG_Float;

src/nbt/tag/Int.php

@@ -24,7 +24,7 @@ namespace PocketMine\NBT\Tag;
 use PocketMine;
 use PocketMine\NBT;
 
-class Int extends NamedNBTTag{
+class Int extends NamedTag{
 
 	public function getType(){
 		return NBT\TAG_Int;

src/nbt/tag/Int_Array.php

@@ -24,7 +24,7 @@ namespace PocketMine\NBT\Tag;
 use PocketMine;
 use PocketMine\NBT;
 
-class Int_Array extends NamedNBTTag{
+class Int_Array extends NamedTag{
 
 	public function getType(){
 		return NBT\TAG_Int_Array;

src/nbt/tag/Long.php

@@ -24,7 +24,7 @@ namespace PocketMine\NBT\Tag;
 use PocketMine;
 use PocketMine\NBT;
 
-class Long extends NamedNBTTag{
+class Long extends NamedTag{
 
 	public function getType(){
 		return NBT\TAG_Long;

src/nbt/tag/NamedTag.php

@@ -19,11 +19,11 @@
  *
 */
 
-namespace PocketMine\NBT;
+namespace PocketMine\NBT\Tag;
 
 use PocketMine;
 
-abstract class NamedNBTTag extends NBTTag{
+abstract class NamedTag extends Tag{
 
 	protected $name;
 

src/nbt/tag/Short.php

@@ -24,7 +24,7 @@ namespace PocketMine\NBT\Tag;
 use PocketMine;
 use PocketMine\NBT;
 
-class Short extends NamedNBTTag{
+class Short extends NamedTag{
 
 	public function getType(){
 		return NBT\TAG_Short;

src/nbt/tag/String.php

@@ -24,7 +24,7 @@ namespace PocketMine\NBT\Tag;
 use PocketMine;
 use PocketMine\NBT;
 
-class String extends NamedNBTTag{
+class String extends NamedTag{
 
 	public function getType(){
 		return NBT\TAG_String;

src/nbt/tag/Tag.php

@@ -19,22 +19,13 @@
  *
 */
 
-namespace PocketMine\NBT;
+/**
-const TAG_End = 0;
+ * All the NBT Tags
-const TAG_Byte = 1;
+ */
-const TAG_Short = 2;
+namespace PocketMine\NBT\Tag;
-const TAG_Int = 3;
-const TAG_Long = 4;
-const TAG_Float = 5;
-const TAG_Double = 6;
-const TAG_Byte_Array = 7;
-const TAG_String = 8;
-const TAG_Enum = 9;
-const TAG_Compound = 10;
-const TAG_Int_Array = 11;
 use PocketMine;
 
-abstract class NBTTag{
+abstract class Tag{
 
 	protected $value;
 

src/network/Handler.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * Network-related classes
+ */
 namespace PocketMine\Network;
 
 use PocketMine\Event\Event as Event;

src/network/protocol/Info.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * Minecraft: PE multiplayer protocol implementation
+ */
 namespace PocketMine\Network\Protocol;
 
 use PocketMine;
@@ -26,6 +29,9 @@ use PocketMine;
 
 abstract class Info{
 
+	/**
+	 * Actual Minecraft: PE protocol version
+	 */
 	const CURRENT_PROTOCOL = 14;
 
 

src/network/protocol/UnknownPacket.php

@@ -19,6 +19,7 @@
  *
 */
 
+
 namespace PocketMine\Network\Protocol;
 
 use PocketMine;

src/network/query/QueryHandler.php

@@ -19,6 +19,10 @@
  *
 */
 
+/**
+ * Implementation of the UT3 Query Protocol (GameSpot)
+ * Source: http://wiki.unrealadmin.org/UT3_query_protocol
+*/
 namespace PocketMine\Network\Query;
 
 use PocketMine\Player as Player;
@@ -26,11 +30,6 @@ use PocketMine\ServerAPI as ServerAPI;
 use PocketMine\Utils\Utils as Utils;
 use PocketMine;
 
-/*
-Implementation of the UT3 Query Protocol (GameSpot)
-Source: http://wiki.unrealadmin.org/UT3_query_protocol
-*/
-
 class QueryHandler{
 	private $socket, $server, $lastToken, $token, $longData, $timeout;
 

src/network/raknet/Info.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * RakNet UDP library implementation
+ */
 namespace PocketMine\Network\RakNet;
 
 use PocketMine;

src/network/rcon/RCON.php

@@ -19,15 +19,16 @@
  *
 */
 
+/**
+ * Implementation of the Source RCON Protocol to allow remote console commands
+ * Source: https://developer.valvesoftware.com/wiki/Source_RCON_Protocol
+*/
 namespace PocketMine\Network\RCON;
 
 use PocketMine;
 use PocketMine\ServerAPI as ServerAPI;
 
-/*
+
-Implementation of the Source RCON Protocol to allow remote console commands
-Source: https://developer.valvesoftware.com/wiki/Source_RCON_Protocol
-*/
 
 class RCON{
 	private $socket, $password, $workers, $threads, $clientsPerThread;

src/network/upnp/PortForward.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * UPnP port forwarding support. Only for Windows
+ */
 namespace PocketMine\Network\UPnP;
 
 use PocketMine;

src/pmf/PMF.php

@@ -19,6 +19,10 @@
  *
 */
 
+/**
+ * PMF (PocketMine Format) handling
+ * TODO: Remove in favor of NBT
+ */
 namespace PocketMine\PMF;
 
 use PocketMine;

src/recipes/Crafting.php

@@ -19,6 +19,9 @@
  *
 */
 
+/**
+ * Crafting / Smelting / Fuel data and fast search databases
+ */
 namespace PocketMine\Recipes;
 
 use PocketMine\BlockAPI as BlockAPI;

src/recipes/Fuel.php

@@ -25,28 +25,28 @@ use PocketMine;
 
 abstract class Fuel{
 	public static $duration = array(
-		COAL => 80,
+		Item\COAL => 80,
-		COAL_BLOCK => 800,
+		Item\COAL_BLOCK => 800,
-		TRUNK => 15,
+		Item\TRUNK => 15,
-		WOODEN_PLANKS => 15,
+		Item\WOODEN_PLANKS => 15,
-		SAPLING => 5,
+		Item\SAPLING => 5,
-		WOODEN_AXE => 10,
+		Item\WOODEN_AXE => 10,
-		WOODEN_PICKAXE => 10,
+		Item\WOODEN_PICKAXE => 10,
-		WOODEN_SWORD => 10,
+		Item\WOODEN_SWORD => 10,
-		WOODEN_SHOVEL => 10,
+		Item\WOODEN_SHOVEL => 10,
-		WOODEN_HOE => 10,
+		Item\WOODEN_HOE => 10,
-		STICK => 5,
+		Item\STICK => 5,
-		FENCE => 15,
+		Item\FENCE => 15,
-		FENCE_GATE => 15,
+		Item\FENCE_GATE => 15,
-		WOODEN_STAIRS => 15,
+		Item\WOODEN_STAIRS => 15,
-		SPRUCE_WOOD_STAIRS => 15,
+		Item\SPRUCE_WOOD_STAIRS => 15,
-		BIRCH_WOOD_STAIRS => 15,
+		Item\BIRCH_WOOD_STAIRS => 15,
-		JUNGLE_WOOD_STAIRS => 15,
+		Item\JUNGLE_WOOD_STAIRS => 15,
-		TRAPDOOR => 15,
+		Item\TRAPDOOR => 15,
-		WORKBENCH => 15,
+		Item\WORKBENCH => 15,
-		BOOKSHELF => 15,
+		Item\BOOKSHELF => 15,
-		CHEST => 15,
+		Item\CHEST => 15,
-		BUCKET => 1000,
+		Item\BUCKET => 1000,
 
 	);