doc update

This commit is contained in:
kremsy
2017-04-07 23:26:35 +02:00
parent 782d8b50e8
commit fa4c16e659
47 changed files with 360 additions and 183 deletions

View File

@ -12,6 +12,7 @@ use ManiaControl\Players\Player;
/**
* Common PlayerStructure Model
*
* @api
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014-2017 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
@ -27,6 +28,7 @@ class CommonPlayerScore implements UsageInformationAble, JsonSerializable {
/**
* Returns the Player
*
* @api
* @return \ManiaControl\Players\Player
*/
public function getPlayer() {
@ -34,6 +36,9 @@ class CommonPlayerScore implements UsageInformationAble, JsonSerializable {
}
/**
* Returns the Player
*
* @api
* @param \ManiaControl\Players\Player $player
*/
public function setPlayer(Player $player) {
@ -43,6 +48,7 @@ class CommonPlayerScore implements UsageInformationAble, JsonSerializable {
/**
* Returns the Rank
*
* @api
* @return int
*/
public function getRank() {
@ -52,6 +58,7 @@ class CommonPlayerScore implements UsageInformationAble, JsonSerializable {
/**
* Sets the Rank
*
* @api
* @param int $rank
*/
public function setRank($rank) {
@ -61,6 +68,7 @@ class CommonPlayerScore implements UsageInformationAble, JsonSerializable {
/**
* Gets the Round Points
*
* @api
* @return int
*/
public function getRoundPoints() {
@ -70,6 +78,7 @@ class CommonPlayerScore implements UsageInformationAble, JsonSerializable {
/**
* Sets the RoundPoints
*
* @api
* @param int $roundPoints
*/
public function setRoundPoints($roundPoints) {
@ -79,6 +88,7 @@ class CommonPlayerScore implements UsageInformationAble, JsonSerializable {
/**
* Gets the Map Points
*
* @api
* @return int
*/
public function getMapPoints() {
@ -88,6 +98,7 @@ class CommonPlayerScore implements UsageInformationAble, JsonSerializable {
/**
* Sets the Map Points
*
* @api
* @param int $mapPoints
*/
public function setMapPoints($mapPoints) {

View File

@ -10,6 +10,7 @@ use ManiaControl\General\UsageInformationTrait;
/**
* TeamScore Model
*
* @api
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014-2017 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
@ -24,6 +25,9 @@ class CommonTeamScore implements UsageInformationAble, JsonSerializable {
private $matchPoints;
/**
* Get the Team Id
*
* @api
* @return mixed
*/
public function getTeamId() {
@ -31,6 +35,9 @@ class CommonTeamScore implements UsageInformationAble, JsonSerializable {
}
/**
* Sets the TeamId
*
* @api
* @param mixed $id
*/
public function setTeamId($id) {
@ -38,13 +45,19 @@ class CommonTeamScore implements UsageInformationAble, JsonSerializable {
}
/**
* @return mixed
* Gets the Name
*
* @api
* @return string
*/
public function getName() {
return $this->name;
}
/**
* Sets the Name
*
* @api
* @param mixed $name
*/
public function setName($name) {
@ -52,6 +65,9 @@ class CommonTeamScore implements UsageInformationAble, JsonSerializable {
}
/**
* Gets the Round Points
*
* @api
* @return mixed
*/
public function getRoundPoints() {
@ -59,6 +75,9 @@ class CommonTeamScore implements UsageInformationAble, JsonSerializable {
}
/**
* Sets the Round Points
*
* @api
* @param mixed $roundPoints
*/
public function setRoundPoints($roundPoints) {
@ -66,6 +85,9 @@ class CommonTeamScore implements UsageInformationAble, JsonSerializable {
}
/**
* Gets the Map Points
*
* @api
* @return mixed
*/
public function getMapPoints() {
@ -73,6 +95,9 @@ class CommonTeamScore implements UsageInformationAble, JsonSerializable {
}
/**
* Sets the Mappoints
*
* @api
* @param mixed $mapPoints
*/
public function setMapPoints($mapPoints) {
@ -80,6 +105,9 @@ class CommonTeamScore implements UsageInformationAble, JsonSerializable {
}
/**
* Gets the Matchpoints
*
* @api
* @return mixed
*/
public function getMatchPoints() {
@ -87,6 +115,9 @@ class CommonTeamScore implements UsageInformationAble, JsonSerializable {
}
/**
* Sets the Match Points
*
* @api
* @param mixed $matchPoints
*/
public function setMatchPoints($matchPoints) {