Add xmldoc and serialisable attributes

This commit is contained in:
Dean Herbert 2019-06-18 15:00:33 +09:00
parent da20904a57
commit 6226889d1c
5 changed files with 23 additions and 0 deletions

View File

@ -1,11 +1,16 @@
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence. // 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. // See the LICENCE file in the repository root for full licence text.
using System;
using Newtonsoft.Json; using Newtonsoft.Json;
using Newtonsoft.Json.Converters; using Newtonsoft.Json.Converters;
namespace osu.Game.Tournament.Models namespace osu.Game.Tournament.Models
{ {
/// <summary>
/// A beatmap choice by a team from a tournament's map pool.
/// </summary>
[Serializable]
public class BeatmapChoice public class BeatmapChoice
{ {
[JsonProperty(DefaultValueHandling = DefaultValueHandling.Populate)] [JsonProperty(DefaultValueHandling = DefaultValueHandling.Populate)]

View File

@ -1,12 +1,17 @@
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence. // 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. // See the LICENCE file in the repository root for full licence text.
using System;
using System.Collections.Generic; using System.Collections.Generic;
using Newtonsoft.Json; using Newtonsoft.Json;
using osu.Framework.Bindables; using osu.Framework.Bindables;
namespace osu.Game.Tournament.Models namespace osu.Game.Tournament.Models
{ {
/// <summary>
/// Holds the complete data required to operate the tournament system.
/// </summary>
[Serializable]
public class LadderInfo public class LadderInfo
{ {
public BindableList<TournamentMatch> Matches = new BindableList<TournamentMatch>(); public BindableList<TournamentMatch> Matches = new BindableList<TournamentMatch>();

View File

@ -1,8 +1,15 @@
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence. // 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. // See the LICENCE file in the repository root for full licence text.
using System;
namespace osu.Game.Tournament.Models namespace osu.Game.Tournament.Models
{ {
/// <summary>
/// A mapping between two <see cref="TournamentMatch"/>es.
/// Used for serialisation exclusively.
/// </summary>
[Serializable]
public class TournamentProgression public class TournamentProgression
{ {
public int SourceID; public int SourceID;

View File

@ -8,6 +8,9 @@ using osu.Framework.Bindables;
namespace osu.Game.Tournament.Models namespace osu.Game.Tournament.Models
{ {
/// <summary>
/// A tournament round, containing many matches, generally executed in a short time period.
/// </summary>
[Serializable] [Serializable]
public class TournamentRound public class TournamentRound
{ {

View File

@ -8,6 +8,9 @@ using osu.Game.Users;
namespace osu.Game.Tournament.Models namespace osu.Game.Tournament.Models
{ {
/// <summary>
/// A team representation. For official tournaments this is generally a country.
/// </summary>
[Serializable] [Serializable]
public class TournamentTeam public class TournamentTeam
{ {