Comments to AudioManager.cs

vchelaru · Dec 30, 2023 · c48cdd6 · c48cdd6
1 parent d6b358b
commit c48cdd6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/Engines/FlatRedBallXNA/FlatRedBall/Audio/AudioManager.cs b/Engines/FlatRedBallXNA/FlatRedBall/Audio/AudioManager.cs
@@ -443,6 +443,10 @@ private static void HandleISongPlaybackStopped(object sender, EventArgs e)
             CurrentlyPlayingISong = null;
         }
 
+        /// <summary>
+        /// Stops the current song (either XNA or ISong) and sets the currently playing song
+        /// to null. This does not clear the CurrentSong/CurrentISong properties, so PlaySong can be called to resume the same song.
+        /// </summary>
         public static void StopSong()
         {
             if(mCurrentISong != null)