Skip to content

Commit

Permalink
Update GameComponentCollection XMl documentation
Browse files Browse the repository at this point in the history
Documentation references the `OnComponentRemoved`, `OnComponentAdded` private methods which causes an invalid bookmark link in the documentation repository.  Correctly updated these to the correct public event references.
Reference: MonoGame/docs.monogame.github.io#14
  • Loading branch information
AristurtleDev committed May 23, 2024
1 parent 4ec53e2 commit 55dbcd0
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions MonoGame.Framework/GameComponentCollection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public sealed class GameComponentCollection : Collection<IGameComponent>

/// <summary>
/// Removes every <see cref="GameComponent"/> from this <see cref="GameComponentCollection"/>.
/// Triggers <see cref="OnComponentRemoved"/> once for each <see cref="GameComponent"/> removed.
/// Triggers <see cref="ComponentRemoved"/> once for each <see cref="GameComponent"/> removed.
/// </summary>
protected override void ClearItems()
{
Expand All @@ -39,7 +39,7 @@ protected override void ClearItems()

/// <summary>
/// Inserts an element into the collection at the specified index.
/// Triggers <see cref="OnComponentAdded(GameComponentCollectionEventArgs)"/>.
/// Triggers <see cref="ComponentAdded"/>.
/// </summary>
/// <param name="index">The zero-based index at which item should be inserted.</param>
/// <param name="item">The object to insert.</param>
Expand Down Expand Up @@ -71,7 +71,7 @@ private void OnComponentRemoved(GameComponentCollectionEventArgs eventArgs)

/// <summary>
/// Removes the element at the specified index of the <see cref="GameComponentCollection"/>.
/// Triggers <see cref="OnComponentRemoved(GameComponentCollectionEventArgs)"/>.
/// Triggers <see cref="ComponentRemoved"/>.
/// </summary>
/// <param name="index">The zero-based index of the element to remove.</param>
protected override void RemoveItem(int index)
Expand Down

0 comments on commit 55dbcd0

Please sign in to comment.