various phpdoc improvements and additions

added some getter methods for properties
This commit is contained in:
Steffen Schröder
2014-07-25 16:28:47 +02:00
parent 29f89ec15f
commit 002b537b47
38 changed files with 381 additions and 188 deletions

View File

@ -26,7 +26,7 @@ class IconManager implements CallbackListener {
const PRELOAD_MLID = 'IconManager.Preload.MLID';
/**
* Some Default icons
* Default icons
*/
const MX_ICON = 'ManiaExchange.png';
const MX_ICON_MOVER = 'ManiaExchange_logo_press.png';
@ -35,13 +35,13 @@ class IconManager implements CallbackListener {
const MX_ICON_GREEN_MOVER = 'ManiaExchange_logo_pressGreen.png';
/**
* Private Properties
* Private properties
*/
private $maniaControl = null;
private $icons = array();
/**
* Create a new Icon Manager
* Construct a new icon manager instance
*
* @param ManiaControl $maniaControl
*/
@ -55,14 +55,13 @@ class IconManager implements CallbackListener {
}
/**
* Add the Set of default Icons
* Add the set of default icons
*/
private function addDefaultIcons() {
$this->addIcon(self::MX_ICON);
$this->addIcon(self::MX_ICON_MOVER);
$this->addIcon(self::MX_ICON_GREEN);
$this->addIcon(self::MX_ICON_GREEN_MOVER);
}
/**
@ -125,4 +124,4 @@ class IconManager implements CallbackListener {
public function handlePlayerConnect(Player $player) {
$this->preloadIcons($player);
}
}
}