From 6226889d1c9f04e96bfd08d9045afed614e123cc Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Tue, 18 Jun 2019 15:00:33 +0900
Subject: [PATCH] Add xmldoc and serialisable attributes

---
 osu.Game.Tournament/Models/BeatmapChoice.cs         | 5 +++++
 osu.Game.Tournament/Models/LadderInfo.cs            | 5 +++++
 osu.Game.Tournament/Models/TournamentProgression.cs | 7 +++++++
 osu.Game.Tournament/Models/TournamentRound.cs       | 3 +++
 osu.Game.Tournament/Models/TournamentTeam.cs        | 3 +++
 5 files changed, 23 insertions(+)

diff --git a/osu.Game.Tournament/Models/BeatmapChoice.cs b/osu.Game.Tournament/Models/BeatmapChoice.cs
index c22077553b..384b349b24 100644
--- a/osu.Game.Tournament/Models/BeatmapChoice.cs
+++ b/osu.Game.Tournament/Models/BeatmapChoice.cs
@@ -1,11 +1,16 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using System;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 
 namespace osu.Game.Tournament.Models
 {
+    /// <summary>
+    /// A beatmap choice by a team from a tournament's map pool.
+    /// </summary>
+    [Serializable]
     public class BeatmapChoice
     {
         [JsonProperty(DefaultValueHandling = DefaultValueHandling.Populate)]
diff --git a/osu.Game.Tournament/Models/LadderInfo.cs b/osu.Game.Tournament/Models/LadderInfo.cs
index b6dc59c0d9..547c4eab08 100644
--- a/osu.Game.Tournament/Models/LadderInfo.cs
+++ b/osu.Game.Tournament/Models/LadderInfo.cs
@@ -1,12 +1,17 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using System;
 using System.Collections.Generic;
 using Newtonsoft.Json;
 using osu.Framework.Bindables;
 
 namespace osu.Game.Tournament.Models
 {
+    /// <summary>
+    /// Holds the complete data required to operate the tournament system.
+    /// </summary>
+    [Serializable]
     public class LadderInfo
     {
         public BindableList<TournamentMatch> Matches = new BindableList<TournamentMatch>();
diff --git a/osu.Game.Tournament/Models/TournamentProgression.cs b/osu.Game.Tournament/Models/TournamentProgression.cs
index 4ef4be599d..3e9b2e05c5 100644
--- a/osu.Game.Tournament/Models/TournamentProgression.cs
+++ b/osu.Game.Tournament/Models/TournamentProgression.cs
@@ -1,8 +1,15 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using System;
+
 namespace osu.Game.Tournament.Models
 {
+    /// <summary>
+    /// A mapping between two <see cref="TournamentMatch"/>es.
+    /// Used for serialisation exclusively.
+    /// </summary>
+    [Serializable]
     public class TournamentProgression
     {
         public int SourceID;
diff --git a/osu.Game.Tournament/Models/TournamentRound.cs b/osu.Game.Tournament/Models/TournamentRound.cs
index e325ad4b96..35215e90c5 100644
--- a/osu.Game.Tournament/Models/TournamentRound.cs
+++ b/osu.Game.Tournament/Models/TournamentRound.cs
@@ -8,6 +8,9 @@
 
 namespace osu.Game.Tournament.Models
 {
+    /// <summary>
+    /// A tournament round, containing many matches, generally executed in a short time period.
+    /// </summary>
     [Serializable]
     public class TournamentRound
     {
diff --git a/osu.Game.Tournament/Models/TournamentTeam.cs b/osu.Game.Tournament/Models/TournamentTeam.cs
index eea1ef8104..54b8a35180 100644
--- a/osu.Game.Tournament/Models/TournamentTeam.cs
+++ b/osu.Game.Tournament/Models/TournamentTeam.cs
@@ -8,6 +8,9 @@
 
 namespace osu.Game.Tournament.Models
 {
+    /// <summary>
+    /// A team representation. For official tournaments this is generally a country.
+    /// </summary>
     [Serializable]
     public class TournamentTeam
     {