From 765e648cb8fb46dda7f919d60626ef8a3f2e710e Mon Sep 17 00:00:00 2001
From: kremsy <lukas@esc-clan.net>
Date: Mon, 30 Dec 2013 16:45:26 +0100
Subject: [PATCH] added variable comments

---
 application/core/ManiaControl.php    |  2 ++
 application/core/Maps/MapManager.php |  2 +-
 application/plugins/WidgetPlugin.php | 20 ++++++++++----------
 3 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/application/core/ManiaControl.php b/application/core/ManiaControl.php
index 2c17b3d3..4d0511d2 100644
--- a/application/core/ManiaControl.php
+++ b/application/core/ManiaControl.php
@@ -2,6 +2,7 @@
 
 namespace ManiaControl;
 
+use IXR_Client_Gbx;
 use ManiaControl\Admin\AdminMenu;
 use ManiaControl\Admin\AuthenticationManager;
 use ManiaControl\Callbacks\CallbackManager;
@@ -71,6 +72,7 @@ class ManiaControl implements CommandListener {
 	public $callbackManager = null;
 	public $chat = null;
 	public $configurator = null;
+	/** @var IXR_Client_Gbx */
 	public $client = null;
 	public $commandManager = null;
 	public $database = null;
diff --git a/application/core/Maps/MapManager.php b/application/core/Maps/MapManager.php
index a8559e8f..8c454eaa 100644
--- a/application/core/Maps/MapManager.php
+++ b/application/core/Maps/MapManager.php
@@ -212,7 +212,7 @@ class MapManager implements CallbackListener {
 	}
 
 	/**
-	 * @return currentMap
+	 * @return Map currentMap
 	 */
 	public function getCurrentMap(){
 		return $this->currentMap;
diff --git a/application/plugins/WidgetPlugin.php b/application/plugins/WidgetPlugin.php
index 5619fc37..38b48301 100644
--- a/application/plugins/WidgetPlugin.php
+++ b/application/plugins/WidgetPlugin.php
@@ -4,15 +4,14 @@ use FML\Controls\Frame;
 use FML\Controls\Labels\Label_Text;
 use FML\Controls\Quad;
 use FML\ManiaLink;
-use FML\Script\Script;
-use FML\Script\Tooltips;
 use ManiaControl\Callbacks\CallbackListener;
 use ManiaControl\ManiaControl;
-use ManiaControl\Maps\Jukebox;
+use ManiaControl\Players\Player;
 use ManiaControl\Players\PlayerManager;
 use ManiaControl\Plugins\Plugin;
 use ManiaControl\Callbacks\CallbackManager;
 
+
 /**
  * ManiaControl Widget Plugin
  *
@@ -55,6 +54,7 @@ class WidgetPlugin implements CallbackListener, Plugin {
 	/**
 	 * Private Properties
 	 */
+	/** @var maniaControl */
 	private $maniaControl = null;
 
 	/**
@@ -159,7 +159,7 @@ class WidgetPlugin implements CallbackListener, Plugin {
 		$labelStyle = $this->maniaControl->manialinkManager->styleManager->getDefaultLabelStyle();
 		
 		$maniaLink = new ManiaLink(self::MLID_NEXTMAPWIDGET);
-		
+
 		// mainframe
 		$frame = new Frame();
 		$maniaLink->add($frame);
@@ -174,7 +174,8 @@ class WidgetPlugin implements CallbackListener, Plugin {
 		
 		// Check if the Next Map is a juked Map
 		$jukedMap = $this->maniaControl->mapManager->jukebox->getNextMap();
-		
+
+		/** @var Player $requester */
 		$requester = null;
 		// if the nextmap is not a juked map, get it from map info
 		if ($jukedMap == null) {
@@ -189,7 +190,7 @@ class WidgetPlugin implements CallbackListener, Plugin {
 			$name = $map->name;
 			$author = $map->authorLogin;
 		}
-		
+
 		$label = new Label_Text();
 		$frame->add($label);
 		$label->setY($height / 2 - 2.3);
@@ -245,8 +246,7 @@ class WidgetPlugin implements CallbackListener, Plugin {
 	/**
 	 * Displays the Map Widget
 	 *
-	 * @param
-	 *        	$login
+	 * @param String $login
 	 */
 	public function displayMapWidget($login = false) {
 		$pos_x = $this->maniaControl->settingManager->getSetting($this, self::SETTING_MAP_WIDGET_POSX);
@@ -269,7 +269,7 @@ class WidgetPlugin implements CallbackListener, Plugin {
 		$frame->add($backgroundQuad);
 		$backgroundQuad->setSize($width, $height);
 		$backgroundQuad->setStyles($quadStyle, $quadSubstyle);
-		
+
 		$map = $this->maniaControl->mapManager->getCurrentMap();
 		
 		$label = new Label_Text();
@@ -293,7 +293,7 @@ class WidgetPlugin implements CallbackListener, Plugin {
 		$label->setScale(0.8);
 		$label->setText($map->authorLogin);
 		$label->setTextColor("FFF");
-		
+
 		// Send manialink
 		$manialinkText = $maniaLink->render()->saveXML();
 		$this->maniaControl->manialinkManager->sendManialink($manialinkText, $login);