suppress CS1591 (Missing XML comment for publicly visible type or mem…

…ber) at project level
lsfera · Jul 4, 2024 · 977f203 · 977f203
1 parent ab10cc1
commit 977f203
Show file tree

Hide file tree

Showing 19 changed files with 11 additions and 19 deletions.
diff --git a/src/Blumchen/Blumchen.csproj b/src/Blumchen/Blumchen.csproj
@@ -25,6 +25,16 @@
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>
         <RootNamespace>Blumchen</RootNamespace>
     </PropertyGroup>
+
+    <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+      <NoWarn>1591</NoWarn>
+      <WarningsNotAsErrors></WarningsNotAsErrors>
+    </PropertyGroup>
+
+    <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
+      <NoWarn>1591</NoWarn>
+      <WarningsNotAsErrors></WarningsNotAsErrors>
+    </PropertyGroup>
     <ItemGroup>
     <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
         <_Parameter1>Tests</_Parameter1>

diff --git a/src/Blumchen/Database/Run.cs b/src/Blumchen/Database/Run.cs
@@ -4,8 +4,6 @@
 using Blumchen.Subscriptions.ReplicationMessageHandlers;
 using Npgsql;
 
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
-
 namespace Blumchen.Database;
 
 public static class Run

diff --git a/src/Blumchen/MessageTableOptions.cs b/src/Blumchen/MessageTableOptions.cs
@@ -3,7 +3,6 @@
 
 namespace Blumchen;
 
-#pragma warning disable CS1591
 public record TableDescriptorBuilder
 {
     private MessageTable TableDescriptor { get; set; } = new();

diff --git a/src/Blumchen/Publications/MessageAppender.cs b/src/Blumchen/Publications/MessageAppender.cs
@@ -3,7 +3,6 @@
 using Npgsql;
 
 namespace Blumchen.Publications;   
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 public static class MessageAppender
 {

diff --git a/src/Blumchen/Publications/PublisherSetupOptionsBuilder.cs b/src/Blumchen/Publications/PublisherSetupOptionsBuilder.cs
@@ -5,7 +5,6 @@
 
 namespace Blumchen.Publications;
 
-#pragma warning disable CS1591
 public class PublisherSetupOptionsBuilder
 {
     private INamingPolicy? _namingPolicy;

diff --git a/src/Blumchen/Serialization/IDictionaryExtensions.cs b/src/Blumchen/Serialization/IDictionaryExtensions.cs
@@ -1,4 +1,3 @@
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 namespace Blumchen.Serialization;
 
 

diff --git a/src/Blumchen/Serialization/INamingPolicy.cs b/src/Blumchen/Serialization/INamingPolicy.cs
@@ -1,5 +1,4 @@
 namespace Blumchen.Serialization;
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 public interface INamingPolicy
 {

diff --git a/src/Blumchen/Serialization/ITypeResolver.cs b/src/Blumchen/Serialization/ITypeResolver.cs
@@ -3,7 +3,6 @@
 using System.Text.Json.Serialization.Metadata;
 
 namespace Blumchen.Serialization;
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 public interface ITypeResolver<T>
 {

diff --git a/src/Blumchen/Serialization/JsonSerialization.cs b/src/Blumchen/Serialization/JsonSerialization.cs
@@ -4,7 +4,6 @@
 using Blumchen.Streams;
 
 namespace Blumchen.Serialization;
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 public static class JsonSerialization
 {

diff --git a/src/Blumchen/Serialization/MessageUrnAttribute.cs b/src/Blumchen/Serialization/MessageUrnAttribute.cs
@@ -1,7 +1,6 @@
 using System.Collections.Concurrent;
 
 namespace Blumchen.Serialization;
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 [AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface)]
 public class MessageUrnAttribute:

diff --git a/src/Blumchen/Subscriptions/IConsume.cs b/src/Blumchen/Subscriptions/IConsume.cs
@@ -1,5 +1,4 @@
 namespace Blumchen.Subscriptions;
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 public interface IConsume;
 

diff --git a/src/Blumchen/Subscriptions/Management/PublicationManagement.cs b/src/Blumchen/Subscriptions/Management/PublicationManagement.cs
@@ -3,7 +3,6 @@
 using Npgsql;
 
 #pragma warning disable CA2208
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 namespace Blumchen.Subscriptions.Management;
 

diff --git a/src/Blumchen/Subscriptions/Management/ReplicationSlotManagement.cs b/src/Blumchen/Subscriptions/Management/ReplicationSlotManagement.cs
@@ -5,7 +5,6 @@
 
 namespace Blumchen.Subscriptions.Management;
 using static ReplicationSlotManagement.CreateReplicationSlotResult;
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 public static class ReplicationSlotManagement
 {

diff --git a/src/Blumchen/Subscriptions/MimeType.cs b/src/Blumchen/Subscriptions/MimeType.cs
@@ -1,6 +1,5 @@
 namespace Blumchen.Subscriptions;
 
-#pragma warning disable CS1591
 public abstract record MimeType(string mimeType)
 {
     public record Json(): MimeType("application/json");

diff --git a/src/Blumchen/Subscriptions/Replication/IReplicationDataMapper.cs b/src/Blumchen/Subscriptions/Replication/IReplicationDataMapper.cs
@@ -3,7 +3,6 @@
 using Npgsql.Replication.PgOutput.Messages;
 
 namespace Blumchen.Subscriptions.Replication;
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 public interface IReplicationDataMapper
 {

diff --git a/src/Blumchen/Subscriptions/ReplicationMessageHandlers/Envelope.cs b/src/Blumchen/Subscriptions/ReplicationMessageHandlers/Envelope.cs
@@ -1,5 +1,4 @@
 namespace Blumchen.Subscriptions.ReplicationMessageHandlers;
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 public interface IEnvelope;
 

diff --git a/src/Blumchen/Subscriptions/SnapshotReader/SnapshotReader.cs b/src/Blumchen/Subscriptions/SnapshotReader/SnapshotReader.cs
@@ -5,7 +5,6 @@
 using Npgsql;
 
 namespace Blumchen.Subscriptions.SnapshotReader;
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 public static class SnapshotReader
 {

diff --git a/src/Blumchen/Subscriptions/Subscription.cs b/src/Blumchen/Subscriptions/Subscription.cs
@@ -12,7 +12,6 @@
 using Npgsql.Replication.PgOutput.Messages;
 
 namespace Blumchen.Subscriptions;
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 using static PublicationManagement;
 using static ReplicationSlotManagement;

diff --git a/src/Blumchen/Subscriptions/SubscriptionOptionsBuilder.cs b/src/Blumchen/Subscriptions/SubscriptionOptionsBuilder.cs
@@ -5,7 +5,7 @@
 using System.Text.Json.Serialization;
 
 namespace Blumchen.Subscriptions;
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+
 public sealed class SubscriptionOptionsBuilder
 {
     private static string? _connectionString;