sim1222/osukey
1
1
Fork 0
mirror of https://github.com/osukey/osukey.git synced 2025-08-03 14:46:38 +09:00
Code Issues Packages Projects Releases Wiki Activity

Add more comprehensive xmldoc for beatmap model classes

Browse Source
This commit is contained in:
Dean Herbert
2022-07-28 15:41:28 +09:00
parent ce48984bda
commit 452d82f292
6 changed files with 32 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
osu.Game/Beatmaps/BeatmapInfo.cs
View File

@ -20,8 +20,12 @@ using Realms;
namespace osu.Game.Beatmaps
{
/// <summary>
/// A single beatmap difficulty.
/// A realm model containing metadata for a single beatmap difficulty.
/// This should generally include anything which is required to be filtered on at song select, or anything pertaining to storage of beatmaps in the client.
/// </summary>
/// <remarks>
/// There are some legacy fields in this model which are not persisted to realm. These are isolated in a code region within the class and should eventually be migrated to `Beatmap`.
/// </remarks>
[ExcludeFromDynamicCompile]
[Serializable]
[MapTo("Beatmap")]