From f40d1a1e81b6e463dac52e4c342d154efce873cd Mon Sep 17 00:00:00 2001 From: unknown Date: Thu, 7 Nov 2024 14:40:43 -0300 Subject: [PATCH 1/2] primera documentacion --- src/Library/WaitingList.cs | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/src/Library/WaitingList.cs b/src/Library/WaitingList.cs index 67b5a4b..1c25f2e 100644 --- a/src/Library/WaitingList.cs +++ b/src/Library/WaitingList.cs @@ -1,14 +1,30 @@ namespace Library; - +/// +/// Esta clase representa la lista de espera. +/// public class WaitingList { + /// + /// Obtiene la lista de jugadores en espera. + /// public List Players { get; private set; }= new List(); + /// + /// Devuelve el número de jugadores en espera. + /// public int Count { get { return this.Players.Count; } } + /// + /// Agrega un jugador a la lista de espera. + /// + /// + /// + ///true si el jugador fue agregado. false si ya estaba esperando. + /// + /// public bool AddPlayer(string playerName) { if (string.IsNullOrEmpty(playerName)) From b2bda216c601d226375002fbcf8909c0c76b7054 Mon Sep 17 00:00:00 2001 From: unknown Date: Thu, 7 Nov 2024 16:36:44 -0300 Subject: [PATCH 2/2] documentacion waitingList GameList --- src/Library/GameList.cs | 40 +++++++++++++++++++++++++++++++++++++- src/Library/WaitingList.cs | 19 +++++++++++++++++- 2 files changed, 57 insertions(+), 2 deletions(-) diff --git a/src/Library/GameList.cs b/src/Library/GameList.cs index 07636ab..865c5d2 100644 --- a/src/Library/GameList.cs +++ b/src/Library/GameList.cs @@ -1,16 +1,47 @@ namespace Library; - +/// +/// Esta clase representa la lista de partidas en curso. +/// public class GameList { + /// + /// Obtiene la lista de partidas. + /// public List Games { get; private set; } = new List(); + /// + /// Agrega una partida a la lista de partidas. + /// + /// + /// + /// La partida agregada. public Game AddGame(Player player1, Player player2) { Game game = new Game(player1, player2); this.Games.Add(game); return game; } + /// + /// Elimina una partida de la lista de partidas. + /// + /// + /// + /// true si la partida fue eliminada. false si no encontró la partida. + /// + public bool RemoveGame(Game game) + { + if (this.Games.Remove(game)) + return true; + return false; + } + /// + /// Devuelve un jugador buscandolo por su nombre + /// + /// + /// + /// null si el jugador no está en ninguna partida. + /// public Player? FindPlayerByName(string playerName) { foreach (Game game in this.Games) @@ -20,6 +51,13 @@ public Game AddGame(Player player1, Player player2) return null; } + /// + /// Devuelve la partida en la que se encuentra un jugador. + /// + /// + /// + /// null si el jugador no está en ninguna partida. + /// public Game? FindGameByPlayer(Player player) { foreach (Game game in this.Games) diff --git a/src/Library/WaitingList.cs b/src/Library/WaitingList.cs index 1c25f2e..999ef71 100644 --- a/src/Library/WaitingList.cs +++ b/src/Library/WaitingList.cs @@ -34,7 +34,14 @@ public bool AddPlayer(string playerName) this.Players.Add(new Player(playerName)); return true; } - + + /// + /// Elimina un jugador de la lista de espera. + /// + /// + /// + ///true si el jugador fue eliminado. false si no estaba esperando. + /// public bool RemovePlayer(string playerName) { Player? player = FindPlayerByName(playerName); @@ -44,6 +51,13 @@ public bool RemovePlayer(string playerName) return true; } + /// + /// Devuelve un jugador de la lista de espera buscandolo por su nombre. + /// + /// + /// + /// null si el jugador no está esperando. + /// public Player? FindPlayerByName(string playerName) { foreach (Player player in this.Players) @@ -52,6 +66,9 @@ public bool RemovePlayer(string playerName) return null; } + /// + /// Devuelve un jugador al azar de la lista de espera. + /// public Player? GetAnyoneWaiting() { Random random = new Random();