1
0
mirror of https://github.com/ppy/osu.git synced 2024-11-11 11:07:52 +08:00

Add a few comments

This commit is contained in:
smoogipoo 2017-12-07 11:17:32 +09:00
parent 499ecb4edd
commit 851c20aff0
2 changed files with 8 additions and 0 deletions

View File

@ -15,6 +15,10 @@ namespace osu.Game.Audio
public const string HIT_NORMAL = @"hitnormal";
public const string HIT_CLAP = @"hitclap";
/// <summary>
/// The <see cref="SoundControlPoint"/> that is used for <see cref="Bank"/> and <see cref="Volume"/>
/// if the values have not already been provided by the hitobject.
/// </summary>
[JsonIgnore]
public SoundControlPoint ControlPoint;

View File

@ -20,6 +20,10 @@ namespace osu.Game.IO.Serialization
public static T DeepClone<T>(this T obj) where T : IJsonSerializable => Deserialize<T>(Serialize(obj));
/// <summary>
/// Creates the default <see cref="JsonSerializerSettings"/> that should be used for all <see cref="IJsonSerializable"/>s.
/// </summary>
/// <returns></returns>
public static JsonSerializerSettings CreateGlobalSettings() => new JsonSerializerSettings
{
ReferenceLoopHandling = ReferenceLoopHandling.Ignore,