From e199ee52252b85ff0b091cc86c6c1c91f1ef2972 Mon Sep 17 00:00:00 2001 From: smoogipoo Date: Wed, 6 Dec 2017 00:42:17 +0900 Subject: [PATCH] Add a few xmldocs --- osu.Game/IO/Serialization/Converters/TypedListConverter.cs | 6 ++++++ osu.Game/IO/Serialization/Converters/Vector2Converter.cs | 3 +++ 2 files changed, 9 insertions(+) diff --git a/osu.Game/IO/Serialization/Converters/TypedListConverter.cs b/osu.Game/IO/Serialization/Converters/TypedListConverter.cs index 1d617422e7..9c35fae7d4 100644 --- a/osu.Game/IO/Serialization/Converters/TypedListConverter.cs +++ b/osu.Game/IO/Serialization/Converters/TypedListConverter.cs @@ -6,6 +6,12 @@ using Newtonsoft.Json.Linq; namespace osu.Game.IO.Serialization.Converters { + /// + /// A type of that serializes a alongside + /// a lookup table for the types contained. The lookup table is used in deserialization to + /// reconstruct the objects with their original types. + /// + /// The type of objects contained in the this attribute is attached to. public class TypedListConverter : JsonConverter { public override bool CanConvert(Type objectType) => objectType == typeof(List); diff --git a/osu.Game/IO/Serialization/Converters/Vector2Converter.cs b/osu.Game/IO/Serialization/Converters/Vector2Converter.cs index 4ec27311bc..5f21018fd5 100644 --- a/osu.Game/IO/Serialization/Converters/Vector2Converter.cs +++ b/osu.Game/IO/Serialization/Converters/Vector2Converter.cs @@ -8,6 +8,9 @@ using OpenTK; namespace osu.Game.IO.Serialization.Converters { + /// + /// A type of that serializes only the X and Y coordinates of a . + /// public class Vector2Converter : JsonConverter { public override bool CanConvert(Type objectType) => objectType == typeof(Vector2);