added license and copyright annotations

improved phpdoc
This commit is contained in:
Steffen Schröder
2014-04-12 12:14:37 +02:00
parent 07a63cf518
commit 08cad46cfc
61 changed files with 345 additions and 204 deletions

View File

@ -21,12 +21,14 @@ use ManiaControl\Manialinks\ManialinkPageAnswerListener;
use ManiaControl\Players\Player;
/**
* Class managing ingame ManiaControl configuration
* Class managing ingame ManiaControl Configuration
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class Configurator implements CallbackListener, CommandListener, ManialinkPageAnswerListener {
/**
/*
* Constants
*/
const ACTION_TOGGLEMENU = 'Configurator.ToggleMenuAction';
@ -39,8 +41,8 @@ class Configurator implements CallbackListener, CommandListener, ManialinkPageAn
const SETTING_MENU_STYLE = 'Menu Widget BackgroundQuad Style';
const SETTING_MENU_SUBSTYLE = 'Menu Widget BackgroundQuad Substyle';
/**
* Private properties
/*
* Private Properties
*/
private $maniaControl = null;
private $scriptSettings = null;

View File

@ -9,6 +9,8 @@ use ManiaControl\Players\Player;
* Interface for Configurator Menus
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
interface ConfiguratorMenu {

View File

@ -1,11 +1,6 @@
<?php
/**
* Class offering a Configurator for Script Settings
*
* @author steeffeen & kremsy
*/
namespace ManiaControl\Configurators;
namespace ManiaControl\Configurators;
use FML\Controls\Control;
use FML\Controls\Entry;
@ -20,8 +15,15 @@ use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\ManiaControl;
use ManiaControl\Players\Player;
/**
* Class offering a Configurator for ManiaControl Settings
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ManiaControlSettings implements ConfiguratorMenu, CallbackListener {
/**
/*
* Constants
*/
const TITLE = 'ManiaControl Settings';
@ -29,7 +31,7 @@ class ManiaControlSettings implements ConfiguratorMenu, CallbackListener {
const ACTION_SETTING_BOOL = 'ManiaControlSettings.ActionBoolSetting.';
const SETTING_PERMISSION_CHANGE_MC_SETTINGS = 'Change ManiaControl Settings';
/**
/*
* Private Properties
*/
private $maniaControl = null;

View File

@ -21,9 +21,11 @@ use ManiaControl\Maps\Map;
* Class offering a Configurator for Script Settings
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ScriptSettings implements ConfiguratorMenu, CallbackListener {
/**
/*
* Constants
*/
const ACTION_PREFIX_SETTING = 'ScriptSetting';
@ -33,7 +35,7 @@ class ScriptSettings implements ConfiguratorMenu, CallbackListener {
const TABLE_SCRIPT_SETTINGS = 'mc_scriptsettings';
const SETTING_LOAD_DEFAULT_SETTINGS_MAP_BEGIN = 'Load Stored Script-Settings on Map-Begin';
/**
/*
* Private Properties
*/
private $maniaControl = null;

View File

@ -14,14 +14,15 @@ use ManiaControl\Callbacks\CallbackManager;
use ManiaControl\ManiaControl;
use ManiaControl\Players\Player;
/**
* Class offering a Configurator for Server Settings
*
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
*/
class ServerSettings implements ConfiguratorMenu, CallbackListener {
/**
/*
* Constants
*/
const ACTION_PREFIX_SETTING = 'ServerSettings';
@ -30,7 +31,7 @@ class ServerSettings implements ConfiguratorMenu, CallbackListener {
const CB_SERVERSETTINGS_CHANGED = 'ServerSettings.SettingsChanged';
const TABLE_SERVER_SETTINGS = 'mc_serversettings';
/**
/*
* Private Properties
*/
private $maniaControl = null;