Skip to content

Commit

Permalink
Add missing XML documentation for Artist (MonoGame#8176)
Browse files Browse the repository at this point in the history
  • Loading branch information
Maniekko authored Feb 13, 2024
1 parent 415cb47 commit 2b4e406
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions MonoGame.Framework/Media/Artist.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@

namespace Microsoft.Xna.Framework.Media
{
/// <summary>
/// Provides access to artist information in the media library.
/// </summary>
/// <remarks>
/// <para>
/// The <see cref="Artist"/> class provides information about an artist, including the artist's <see cref="Name"/>, <see cref="Albums"/>, and <see cref="Songs"/>
/// </para>
/// <para>
/// You can obtain an <b>Artist</b> through the <see cref="Album.Artist"/> and <see cref="Song.Artist"/> properties.
/// </para>
/// </remarks>
public sealed class Artist : IDisposable
{
private string artist;
Expand Down Expand Up @@ -54,6 +65,10 @@ public SongCollection Songs
}
}

/// <summary>
/// Creates a new instance of <see cref="Artist"/> class.
/// </summary>
/// <param name="artist">Name of the artist.</param>
public Artist(string artist)
{
this.artist = artist;
Expand Down

0 comments on commit 2b4e406

Please sign in to comment.