mark equality members obsolete with instructions

Author: angularsen

CodeGen/Generators/UnitsNetGen/QuantityGenerator.cs

@@ -752,20 +752,43 @@ private void GenerateEqualityAndComparison()
             return left.Value > right.ToUnit(left.Unit).Value;
         }}
 
-        /// <summary>Returns true if both <see cref=""Value"" /> and <see cref=""Unit"" /> are exactly equal for both quantities.</summary>
-        /// <remarks>Consider using <see cref=""Equals({_quantity.Name}, double, ComparisonType)""/> for comparing floating-point values with rounding error tolerances.</remarks>
+        /// <summary>Indicates strict equality of two <see cref=""{_quantity.Name}""/> quantities, where both <see cref=""Value"" /> and <see cref=""Unit"" /> are exactly equal.</summary>
+        /// <remarks>Consider using <see cref=""Equals({_quantity.Name}, double, ComparisonType)""/> to check equality across different units and to specify a floating-point number error tolerance.</remarks>
+        [Obsolete(""Consider using Equals(Angle, double, ComparisonType) to check equality across different units and to specify a floating-point number error tolerance."")]
         public static bool operator ==({_quantity.Name} left, {_quantity.Name} right)
         {{
             return left.Equals(right);
         }}
 
-        /// <summary>Returns true if either <see cref=""Value"" /> or <see cref=""Unit"" /> are not exactly equal for both quantities.</summary>
-        /// <remarks>Consider using <see cref=""Equals({_quantity.Name}, double, ComparisonType)""/> for comparing floating-point values with rounding error tolerances.</remarks>
+        /// <summary>Indicates strict inequality of two <see cref=""{_quantity.Name}""/> quantities, where both <see cref=""Value"" /> and <see cref=""Unit"" /> are exactly equal.</summary>
+        /// <remarks>Consider using <see cref=""Equals({_quantity.Name}, double, ComparisonType)""/> to check equality across different units and to specify a floating-point number error tolerance.</remarks>
+        [Obsolete(""Consider using Equals(Angle, double, ComparisonType) to check equality across different units and to specify a floating-point number error tolerance."")]
         public static bool operator !=({_quantity.Name} left, {_quantity.Name} right)
         {{
             return !(left == right);
         }}
 
+        /// <inheritdoc />
+        /// <summary>Indicates strict equality of two <see cref=""{_quantity.Name}""/> quantities, where both <see cref=""Value"" /> and <see cref=""Unit"" /> are exactly equal.</summary>
+        /// <remarks>Consider using <see cref=""Equals({_quantity.Name}, double, ComparisonType)""/> to check equality across different units and to specify a floating-point number error tolerance.</remarks>
+        [Obsolete(""Consider using Equals(Angle, double, ComparisonType) to check equality across different units and to specify a floating-point number error tolerance."")]
+        public override bool Equals(object obj)
+        {{
+            if (obj is null || !(obj is {_quantity.Name} otherQuantity))
+                return false;
+
+            return Equals(otherQuantity);
+        }}
+
+        /// <inheritdoc />
+        /// <summary>Indicates strict equality of two <see cref=""{_quantity.Name}""/> quantities, where both <see cref=""Value"" /> and <see cref=""Unit"" /> are exactly equal.</summary>
+        /// <remarks>Consider using <see cref=""Equals({_quantity.Name}, double, ComparisonType)""/> to check equality across different units and to specify a floating-point number error tolerance.</remarks>
+        [Obsolete(""Consider using Equals(Angle, double, ComparisonType) to check equality across different units and to specify a floating-point number error tolerance."")]
+        public bool Equals({_quantity.Name} other)
+        {{
+            return new {{ Value, Unit }}.Equals(new {{ other.Value, other.Unit }});
+        }}
+
         /// <summary>Compares the current <see cref=""{_quantity.Name}""/> with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other when converted to the same unit.</summary>
         /// <param name=""obj"">An object to compare with this instance.</param>
         /// <exception cref=""T:System.ArgumentException"">
@@ -802,25 +825,6 @@ public int CompareTo({_quantity.Name} other)
             return _value.CompareTo(other.ToUnit(this.Unit).Value);
         }}
 
-        /// <inheritdoc />
-        /// <summary>Indicates strict equality of two <see cref=""{_quantity.Name}""/> quantities, where both <see cref=""Value"" /> and <see cref=""Unit"" /> are exactly equal.</summary>
-        /// <remarks>Consider using <see cref=""Equals({_quantity.Name}, double, ComparisonType)""/> to check equality across different units and to specify a floating-point number error tolerance.</remarks>
-        public override bool Equals(object obj)
-        {{
-            if (obj is null || !(obj is {_quantity.Name} otherQuantity))
-                return false;
-
-            return Equals(otherQuantity);
-        }}
-
-        /// <inheritdoc />
-        /// <summary>Indicates strict equality of two <see cref=""{_quantity.Name}""/> quantities, where both <see cref=""Value"" /> and <see cref=""Unit"" /> are exactly equal.</summary>
-        /// <remarks>Consider using <see cref=""Equals({_quantity.Name}, double, ComparisonType)""/> to check equality across different units and to specify a floating-point number error tolerance.</remarks>
-        public bool Equals({_quantity.Name} other)
-        {{
-            return new {{ Value, Unit }}.Equals(new {{ other.Value, other.Unit }});
-        }}
-
         /// <summary>
         ///     <para>
         ///     Compare equality to another {_quantity.Name} within the given absolute or relative tolerance.