Skip to content

Commit

Permalink
Add comments for ItemAdded/Removed (suggestion from peppy)
Browse files Browse the repository at this point in the history
  • Loading branch information
hwsmm committed Oct 25, 2024
1 parent 9a28f89 commit 271c6b6
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions osu.Framework/Audio/AudioCollectionManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,23 @@ protected override void UpdateChildren()
}
}

/// <summary>
/// An item has been added to <see cref="Items"/>.
/// </summary>
/// <param name="item">The item which was added.</param>
protected virtual void ItemAdded(T item)
{
}

/// <summary>
/// An item has been removed from <see cref="Items"/>.
/// Importantly, dispose of the <paramref name="item"/> here if required.
/// </summary>
/// <remarks>
/// Disposal is left up to the implementor because some cases of removal see items managed by a higher
/// level class, i.e. SampleBassFactory.
/// </remarks>
/// <param name="item">The item which was removed.</param>
protected virtual void ItemRemoved(T item)
{
}
Expand Down

0 comments on commit 271c6b6

Please sign in to comment.