style: split up the classes in custom kubernets entity

This removes the need for the suppresswarning

Author: Christoph Bühler

src/KubeOps/Operator/Entities/CustomKubernetesEntity.cs

@@ -1,36 +1,13 @@
-using System.Diagnostics.CodeAnalysis;
-using k8s;
+using k8s;
 using k8s.Models;
 
 namespace KubeOps.Operator.Entities
 {
-    [SuppressMessage(
-        "StyleCop.CSharp.MaintainabilityRules",
-        "SA1402:FileMayOnlyContainASingleType",
-        Justification = "This naming of generics should appear in the same file.")]
+    /// <summary>
+    /// Defines a custom kubernetes entity which can be used in finalizers and controllers.
+    /// </summary>
     public abstract class CustomKubernetesEntity : KubernetesObject, IKubernetesObject<V1ObjectMeta>
     {
         public V1ObjectMeta Metadata { get; set; } = new V1ObjectMeta();
     }
-
-    [SuppressMessage(
-        "StyleCop.CSharp.MaintainabilityRules",
-        "SA1402:FileMayOnlyContainASingleType",
-        Justification = "This naming of generics should appear in the same file.")]
-    public abstract class CustomKubernetesEntity<TSpec> : CustomKubernetesEntity, ISpec<TSpec>
-        where TSpec : new()
-    {
-        public TSpec Spec { get; set; } = new TSpec();
-    }
-
-    [SuppressMessage(
-        "StyleCop.CSharp.MaintainabilityRules",
-        "SA1402:FileMayOnlyContainASingleType",
-        Justification = "This naming of generics should appear in the same file.")]
-    public abstract class CustomKubernetesEntity<TSpec, TStatus> : CustomKubernetesEntity<TSpec>, IStatus<TStatus>
-        where TSpec : new()
-        where TStatus : new()
-    {
-        public TStatus Status { get; set; } = new TStatus();
-    }
 }

src/KubeOps/Operator/Entities/CustomKubernetesEntity{TSpec,TStatus}.cs

@@ -0,0 +1,19 @@
+using k8s;
+
+namespace KubeOps.Operator.Entities
+{
+    /// <summary>
+    /// Defines a custom kubernetes entity which can be used in finalizers and controllers.
+    /// This entity contains a spec (like <see cref="CustomKubernetesEntity{TSpec}"/>)
+    /// and a status (<see cref="Status"/>) which can be updated to reflect the state
+    /// of the entity.
+    /// </summary>
+    /// <typeparam name="TSpec">The type of the specified data.</typeparam>
+    /// <typeparam name="TStatus">The type of the status data.</typeparam>
+    public abstract class CustomKubernetesEntity<TSpec, TStatus> : CustomKubernetesEntity<TSpec>, IStatus<TStatus>
+        where TSpec : new()
+        where TStatus : new()
+    {
+        public TStatus Status { get; set; } = new TStatus();
+    }
+}

src/KubeOps/Operator/Entities/CustomKubernetesEntity{TSpec}.cs

@@ -0,0 +1,15 @@
+using k8s;
+
+namespace KubeOps.Operator.Entities
+{
+    /// <summary>
+    /// Defines a custom kubernetes entity which can be used in finalizers and controllers.
+    /// This entity contains a <see cref="Spec"/>, which means in contains specified data.
+    /// </summary>
+    /// <typeparam name="TSpec">The type of the specified data.</typeparam>
+    public abstract class CustomKubernetesEntity<TSpec> : CustomKubernetesEntity, ISpec<TSpec>
+        where TSpec : new()
+    {
+        public TSpec Spec { get; set; } = new TSpec();
+    }
+}