Restoring XML documentation to all projects

naudio · Jul 31, 2022 · 0cd2aba · 0cd2aba
1 parent 8f1daa7
commit 0cd2aba
Show file tree

Hide file tree

Showing 9 changed files with 22 additions and 8 deletions.
diff --git a/NAudio.Asio/NAudio.Asio.csproj b/NAudio.Asio/NAudio.Asio.csproj
@@ -5,6 +5,7 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <Version>2.1.0</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <GenerateDocumentationFile Condition=" '$(Configuration)' == 'Release' ">true</GenerateDocumentationFile>
     <Authors>Mark Heath</Authors>
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\NAudioStrongNameKey.snk</AssemblyOriginatorKeyFile>

diff --git a/NAudio.Core/NAudio.Core.csproj b/NAudio.Core/NAudio.Core.csproj
@@ -5,6 +5,7 @@
     <Authors>Mark Heath</Authors>
     <Version>2.1.0</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <GenerateDocumentationFile Condition=" '$(Configuration)' == 'Release' ">true</GenerateDocumentationFile>
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\NAudioStrongNameKey.snk</AssemblyOriginatorKeyFile>
     <PackageProjectUrl>https://github.com/naudio/NAudio</PackageProjectUrl>

diff --git a/NAudio.Extras/NAudio.Extras.csproj b/NAudio.Extras/NAudio.Extras.csproj
@@ -5,6 +5,7 @@
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\NAudioStrongNameKey.snk</AssemblyOriginatorKeyFile>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <GenerateDocumentationFile Condition=" '$(Configuration)' == 'Release' ">true</GenerateDocumentationFile>
     <Authors>Mark Heath</Authors>
     <PackageProjectUrl>https://github.com/naudio/NAudio</PackageProjectUrl>
     <PackageTags>C# .NET audio sound</PackageTags>

diff --git a/NAudio.Midi/NAudio.Midi.csproj b/NAudio.Midi/NAudio.Midi.csproj
@@ -4,6 +4,7 @@
     <TargetFramework>netstandard2.0</TargetFramework>
     <Version>2.1.0</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <GenerateDocumentationFile Condition=" '$(Configuration)' == 'Release' ">true</GenerateDocumentationFile>
     <Authors>Mark Heath</Authors>
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\NAudioStrongNameKey.snk</AssemblyOriginatorKeyFile>

diff --git a/NAudio.Uap/NAudio.Uap.csproj b/NAudio.Uap/NAudio.Uap.csproj
@@ -5,6 +5,7 @@
     <TargetFramework>uap10.0.18362</TargetFramework>
     <Version>2.1.0</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <GenerateDocumentationFile Condition=" '$(Configuration)' == 'Release' ">true</GenerateDocumentationFile>
     <Authors>Mark Heath</Authors>
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\NAudioStrongNameKey.snk</AssemblyOriginatorKeyFile>

diff --git a/NAudio.Wasapi/NAudio.Wasapi.csproj b/NAudio.Wasapi/NAudio.Wasapi.csproj
@@ -4,6 +4,7 @@
     <TargetFrameworks>netstandard2.0;uap10.0.18362</TargetFrameworks>
     <Version>2.1.0</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <GenerateDocumentationFile Condition=" '$(Configuration)' == 'Release' ">true</GenerateDocumentationFile>
     <Authors>Mark Heath</Authors>
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\NAudioStrongNameKey.snk</AssemblyOriginatorKeyFile>

diff --git a/NAudio.WinForms/NAudio.WinForms.csproj b/NAudio.WinForms/NAudio.WinForms.csproj
@@ -5,6 +5,7 @@
     <UseWindowsForms>true</UseWindowsForms>
     <Version>2.1.0</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <GenerateDocumentationFile Condition=" '$(Configuration)' == 'Release' ">true</GenerateDocumentationFile>
     <Authors>Mark Heath</Authors>
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\NAudioStrongNameKey.snk</AssemblyOriginatorKeyFile>

diff --git a/NAudio.WinMM/NAudio.WinMM.csproj b/NAudio.WinMM/NAudio.WinMM.csproj
@@ -4,6 +4,7 @@
     <TargetFrameworks>netstandard2.0</TargetFrameworks>
     <Version>2.1.0</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <GenerateDocumentationFile Condition=" '$(Configuration)' == 'Release' ">true</GenerateDocumentationFile>
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\NAudioStrongNameKey.snk</AssemblyOriginatorKeyFile>
     <PackageProjectUrl>https://github.com/naudio/NAudio</PackageProjectUrl>

diff --git a/NAudioWpfDemo/MediaFoundationEncode/MediaFoundationEncodeViewModel.cs b/NAudioWpfDemo/MediaFoundationEncode/MediaFoundationEncodeViewModel.cs
@@ -69,9 +69,11 @@ private bool TryOpenInputFile(string file)
             bool isValid = false;
             try
             {
-                using var reader = new MediaFoundationReader(file);
-                InputFormat = reader.WaveFormat.ToString();
-                inputWaveFormat = reader.WaveFormat;
+                using (var reader = new MediaFoundationReader(file))
+                {
+                    InputFormat = reader.WaveFormat.ToString();
+                    inputWaveFormat = reader.WaveFormat;
+                }
                 isValid = true;
             }
             catch (Exception e)
@@ -185,11 +187,15 @@ private void Encode()
                 return;
             }
 
-            using var reader = new MediaFoundationReader(InputFile);
-            string outputUrl = SelectSaveFile(SelectedOutputFormat.Name, SelectedOutputFormat.Extension);
-            if (outputUrl == null) return;
-            using var encoder = new MediaFoundationEncoder(SelectedMediaType.MediaType);
-            encoder.Encode(outputUrl, reader);
+            using (var reader = new MediaFoundationReader(InputFile))
+            {
+                string outputUrl = SelectSaveFile(SelectedOutputFormat.Name, SelectedOutputFormat.Extension);
+                if (outputUrl == null) return;
+                using (var encoder = new MediaFoundationEncoder(SelectedMediaType.MediaType))
+                {
+                    encoder.Encode(outputUrl, reader);
+                }                    
+            }
         }
 
         private string SelectSaveFile(string formatName, string extension)