RepoMirrors/osu
1
0
Fork 0
mirror of https://github.com/ppy/osu synced 2024-12-26 17:02:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add mention to detach methods of only running once

Browse Source
This commit is contained in:
Dean Herbert 2022-01-10 12:54:24 +09:00
parent 3c3210e8ef
commit d072f1d08d
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
osu.Game/Database/RealmObjectExtensions.cs
View File

@ -26,6 +26,9 @@ namespace osu.Game.Database
/// <summary>
/// Create a detached copy of the each item in the collection.
/// </summary>
/// <remarks>
/// Items which are already detached (ie. not managed by realm) will not be modified.
/// </remarks>
/// <param name="items">A list of managed <see cref="RealmObject"/>s to detach.</param>
/// <typeparam name="T">The type of object.</typeparam>
/// <returns>A list containing non-managed copies of provided items.</returns>
@ -42,6 +45,9 @@ namespace osu.Game.Database
/// <summary>
/// Create a detached copy of the item.
/// </summary>
/// <remarks>
/// If the item if already detached (ie. not managed by realm) it will not be detached again and the original instance will be returned. This allows this method to be potentially called at multiple levels while only incurring the clone overhead once.
/// </remarks>
/// <param name="item">The managed <see cref="RealmObject"/> to detach.</param>
/// <typeparam name="T">The type of object.</typeparam>
/// <returns>A non-managed copy of provided item. Will return the provided item if already detached.</returns>