Audio: Update Documentation

Ryujinx.Audio/Helpers/TypeSize.cs

@@ -4,9 +4,8 @@ using System.Reflection.Emit;
 namespace Ryujinx.Audio
 {
     /// <summary>
-    /// Helper to determine the byte size of a type
+    /// Helper to determine the byte size of type <see cref="T"/>
     /// </summary>
-    /// <typeparam name="T"></typeparam>
     public static class TypeSize<T>
     {
         /// <summary>

Ryujinx.Audio/PlaybackState.cs

@@ -1,8 +1,17 @@
 namespace Ryujinx.Audio
 {
+    /// <summary>
+    /// The playback state of a track
+    /// </summary>
     public enum PlaybackState
     {
+        /// <summary>
+        ///  The track is currently playing
+        /// </summary>
         Playing = 0,
+        /// <summary>
+        /// The track is currently stopped
+        /// </summary>
         Stopped = 1
     }
 }

Ryujinx.Audio/Renderers/SoundIo/SoundIoAudioTrack.cs

@@ -56,9 +56,9 @@ namespace Ryujinx.Audio.SoundIo
         /// <summary>
         /// Constructs a new instance of a <see cref="SoundIoAudioTrack"/>
         /// </summary>
-        /// <param name="trackId"></param>
+        /// <param name="trackId">The track ID</param>
-        /// <param name="audioContext"></param>
+        /// <param name="audioContext">The SoundIO audio context</param>
-        /// <param name="audioDevice"></param>
+        /// <param name="audioDevice">The SoundIO audio device</param>
         public SoundIoAudioTrack(int trackId, SoundIO audioContext, SoundIODevice audioDevice)
         {
             TrackID = trackId;

Ryujinx.Audio/Renderers/SoundIo/SoundIoAudioTrackPool.cs

@@ -116,8 +116,7 @@ namespace Ryujinx.Audio.SoundIo
         /// <summary>
         /// Retrieves the <see cref="SoundIoAudioTrack"/> associated with the specified <paramref name="trackId"/> from the pool
         /// </summary>
-        /// <param name="trackId"></param>
+        /// <param name="trackId">The ID of the track to retrieve</param>
-        /// <returns></returns>
         public SoundIoAudioTrack Get(int trackId)
         {
             if (m_TrackList.TryGetValue(trackId, out SoundIoAudioTrack track))
@@ -129,7 +128,7 @@ namespace Ryujinx.Audio.SoundIo
         /// <summary>
         /// Attempers to get a <see cref="SoundIoAudioTrack"/> from the pool
         /// </summary>
-        /// <param name="track"></param>
+        /// <param name="track">The track retrieved from the pool</param>
         /// <returns>True if retrieve was successful</returns>
         public bool TryGet(out SoundIoAudioTrack track)
         {
@@ -140,8 +139,8 @@ namespace Ryujinx.Audio.SoundIo
         /// <summary>
         /// Attempts to get the <see cref="SoundIoAudioTrack" /> associated with the specified <paramref name="trackId"/> from the pool
         /// </summary>
-        /// <param name="trackId"></param>
+        /// <param name="trackId">The ID of the track to retrieve</param>
-        /// <param name="track"></param>
+        /// <param name="track">The track retrieved from the pool</param>
         public bool TryGet(int trackId, out SoundIoAudioTrack track)
         {
             return m_TrackList.TryGetValue(trackId, out track);

Ryujinx.Audio/Renderers/SoundIo/SoundIoBuffer.cs

@@ -18,8 +18,8 @@
         /// <summary>
         /// Constructs a new instance of a <see cref="SoundIoBuffer"/>
         /// </summary>
-        /// <param name="tag"></param>
+        /// <param name="tag">The buffer tag</param>
-        /// <param name="length"></param>
+        /// <param name="length">The size of the buffer</param>
         public SoundIoBuffer(long tag, int length)
         {
             Tag = tag;