doc - Added missing documentation

--- We've added missing documentation in the FormatTools documentation. --- Type: doc Breaking: False Doc Required: False Backport Required: False Part: 1/1
Aptivi · Sep 18, 2024 · a92b595 · a92b595
1 parent 14844ae
commit a92b595
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/BassBoom.Basolia/Format/FormatTools.cs b/BassBoom.Basolia/Format/FormatTools.cs
@@ -40,6 +40,7 @@ public static class FormatTools
         /// <summary>
         /// Gets the format information
         /// </summary>
+        /// <param name="basolia">Basolia instance that contains a valid handle</param>
         public static (long rate, int channels, int encoding) GetFormatInfo(BasoliaMedia? basolia)
         {
             if (basolia is null)
@@ -123,7 +124,7 @@ public static string GetEncodingName(int encoding)
             // We're now entering the dangerous zone
             unsafe
             {
-                // Get the encodings
+                // Get the encoding name
                 var @delegate = MpgNative.GetDelegate<NativeOutputLib.out123_enc_name>(MpgNative.libManagerOut, nameof(NativeOutputLib.out123_enc_name));
                 IntPtr namePtr = @delegate.Invoke(encoding);
                 encodingName = Marshal.PtrToStringAnsi(namePtr);
@@ -151,7 +152,7 @@ public static string GetEncodingDescription(int encoding)
             // We're now entering the dangerous zone
             unsafe
             {
-                // Get the encodings
+                // Get the encoding description
                 var @delegate = MpgNative.GetDelegate<NativeOutputLib.out123_enc_longname>(MpgNative.libManagerOut, nameof(NativeOutputLib.out123_enc_longname));
                 IntPtr descriptionPtr = @delegate.Invoke(encoding);
                 encodingDescription = Marshal.PtrToStringAnsi(descriptionPtr);
@@ -164,8 +165,10 @@ public static string GetEncodingDescription(int encoding)
         /// <summary>
         /// Gets the supported formats
         /// </summary>
+        /// <param name="basolia">Basolia instance that contains a valid handle</param>
         public static FormatInfo[] GetFormats(BasoliaMedia? basolia)
         {
+            InitBasolia.CheckInited();
             if (basolia is null)
                 throw new BasoliaException("Basolia instance is not provided", mpg123_errors.MPG123_BAD_HANDLE);
             var formats = new List<FormatInfo>();