adding a lil more doc again
continuous-integration/drone/push Build is passing Details

master
rportet 11 months ago
parent d9afae006d
commit ffbd8aba48

@ -10,7 +10,7 @@ using QwirkleClassLibrary.Tiles;
namespace QwirkleClassLibrary.Games namespace QwirkleClassLibrary.Games
{ {
/// <summary> /// <summary>
/// This interface is used to define the functions used in the game. It is mainly about all the rules of the games, chacking if the player moves are correct. /// This interface is used to define the functions used in the game. It is mainly about all the rules of the games, checking if the player moves are correct.
/// </summary> /// </summary>
public interface IRules public interface IRules
{ {

@ -12,6 +12,9 @@ using System.Threading.Tasks;
namespace QwirkleClassLibrary.Players namespace QwirkleClassLibrary.Players
{ {
/// <summary>
/// The purpose of this class is to save data at the end of a game so players can consult it later, comparing their best scores along their games.
/// </summary>
[DataContract] [DataContract]
public class Leaderboard : INotifyPropertyChanged public class Leaderboard : INotifyPropertyChanged
{ {

@ -12,6 +12,9 @@ using QwirkleClassLibrary.Tiles;
namespace QwirkleClassLibrary.Players namespace QwirkleClassLibrary.Players
{ {
/// <summary>
/// This class is mainly used to manage the sets of tiles of players during the game.
/// </summary>
[DataContract] [DataContract]
public class Player : INotifyPropertyChanged public class Player : INotifyPropertyChanged
{ {

@ -9,6 +9,9 @@ using System.Threading.Tasks;
namespace QwirkleClassLibrary.Players namespace QwirkleClassLibrary.Players
{ {
/// <summary>
/// The main purpose of this class is to save the data of the scores during the games, allowing the app to back up data.
/// </summary>
[DataContract] [DataContract]
public class Score public class Score
{ {

@ -8,6 +8,9 @@ using System.Threading.Tasks;
namespace QwirkleClassLibrary.Tiles namespace QwirkleClassLibrary.Tiles
{ {
/// <summary>
/// This is the class for the Tile, it defines what it is and what can be done with it.
/// </summary>
[DataContract] [DataContract]
public class Tile : IComparable public class Tile : IComparable
{ {

@ -8,6 +8,9 @@ using System.Threading.Tasks;
namespace QwirkleClassLibrary.Tiles namespace QwirkleClassLibrary.Tiles
{ {
/// <summary>
/// This class is used during the game for the tile redistribution system.
/// </summary>
[DataContract] [DataContract]
public class TileBag public class TileBag
{ {

Loading…
Cancel
Save