Skip to content

Commit 0211ecc

Browse files
tmilnthorpangularsen
authored andcommitted
Fixing ~1200 warnings by disabling XML comment warnings for generated… (#475)
* Fixing ~1200 warnings by disabling XML comment warnings for generated unit enums. Move obsolete tag for ToStringDefaultUnit to make XML comment valid. * Adding missing comments to remove warnings * Fix warnings for .cs files being included twice in compile group as well as "none" group.
1 parent 2349233 commit 0211ecc

File tree

274 files changed

+2007
-187
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

274 files changed

+2007
-187
lines changed

Common/GeneratedCode/Quantities/Acceleration.Common.g.cs

+11-1
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ static Acceleration()
8282
BaseDimensions = new BaseDimensions(1, 0, -2, 0, 0, 0, 0);
8383
}
8484

85+
/// <summary>
86+
/// Creates the quantity with the given value in the base unit MeterPerSecondSquared.
87+
/// </summary>
8588
[Obsolete("Use the constructor that takes a unit parameter. This constructor will be removed in a future version.")]
8689
public Acceleration(double meterspersecondsquared)
8790
{
@@ -227,6 +230,9 @@ public static BaseDimensions BaseDimensions
227230

228231
#region Static
229232

233+
/// <summary>
234+
/// Gets an instance of this quantity with a value of 0 in the base unit MeterPerSecondSquared.
235+
/// </summary>
230236
public static Acceleration Zero => new Acceleration(0, BaseUnit);
231237

232238
/// <summary>
@@ -567,6 +573,10 @@ public bool Equals(Acceleration other, Acceleration maxError)
567573
return Math.Abs(_value - other.AsBaseNumericType(this.Unit)) <= maxError.AsBaseNumericType(this.Unit);
568574
}
569575

576+
/// <summary>
577+
/// Returns the hash code for this instance.
578+
/// </summary>
579+
/// <returns>A hash code for the current Acceleration.</returns>
570580
public override int GetHashCode()
571581
{
572582
return new { Value, Unit }.GetHashCode();
@@ -729,10 +739,10 @@ public static AccelerationUnit ParseUnit(string str, [CanBeNull] string cultureN
729739

730740
#endregion
731741

732-
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
733742
/// <summary>
734743
/// Set the default unit used by ToString(). Default is MeterPerSecondSquared
735744
/// </summary>
745+
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
736746
public static AccelerationUnit ToStringDefaultUnit { get; set; } = AccelerationUnit.MeterPerSecondSquared;
737747

738748
/// <summary>

Common/GeneratedCode/Quantities/AmountOfSubstance.Common.g.cs

+11-1
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ static AmountOfSubstance()
8282
BaseDimensions = new BaseDimensions(0, 0, 0, 0, 0, 1, 0);
8383
}
8484

85+
/// <summary>
86+
/// Creates the quantity with the given value in the base unit Mole.
87+
/// </summary>
8588
[Obsolete("Use the constructor that takes a unit parameter. This constructor will be removed in a future version.")]
8689
public AmountOfSubstance(double moles)
8790
{
@@ -232,6 +235,9 @@ public static BaseDimensions BaseDimensions
232235

233236
#region Static
234237

238+
/// <summary>
239+
/// Gets an instance of this quantity with a value of 0 in the base unit Mole.
240+
/// </summary>
235241
public static AmountOfSubstance Zero => new AmountOfSubstance(0, BaseUnit);
236242

237243
/// <summary>
@@ -586,6 +592,10 @@ public bool Equals(AmountOfSubstance other, AmountOfSubstance maxError)
586592
return Math.Abs(_value - other.AsBaseNumericType(this.Unit)) <= maxError.AsBaseNumericType(this.Unit);
587593
}
588594

595+
/// <summary>
596+
/// Returns the hash code for this instance.
597+
/// </summary>
598+
/// <returns>A hash code for the current AmountOfSubstance.</returns>
589599
public override int GetHashCode()
590600
{
591601
return new { Value, Unit }.GetHashCode();
@@ -750,10 +760,10 @@ public static AmountOfSubstanceUnit ParseUnit(string str, [CanBeNull] string cul
750760

751761
#endregion
752762

753-
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
754763
/// <summary>
755764
/// Set the default unit used by ToString(). Default is Mole
756765
/// </summary>
766+
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
757767
public static AmountOfSubstanceUnit ToStringDefaultUnit { get; set; } = AmountOfSubstanceUnit.Mole;
758768

759769
/// <summary>

Common/GeneratedCode/Quantities/AmplitudeRatio.Common.g.cs

+11-1
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@ static AmplitudeRatio()
8181
{
8282
}
8383

84+
/// <summary>
85+
/// Creates the quantity with the given value in the base unit DecibelVolt.
86+
/// </summary>
8487
[Obsolete("Use the constructor that takes a unit parameter. This constructor will be removed in a future version.")]
8588
public AmplitudeRatio(double decibelvolts)
8689
{
@@ -181,6 +184,9 @@ public static BaseDimensions BaseDimensions
181184

182185
#region Static
183186

187+
/// <summary>
188+
/// Gets an instance of this quantity with a value of 0 in the base unit DecibelVolt.
189+
/// </summary>
184190
public static AmplitudeRatio Zero => new AmplitudeRatio(0, BaseUnit);
185191

186192
/// <summary>
@@ -395,6 +401,10 @@ public bool Equals(AmplitudeRatio other, AmplitudeRatio maxError)
395401
return Math.Abs(_value - other.AsBaseNumericType(this.Unit)) <= maxError.AsBaseNumericType(this.Unit);
396402
}
397403

404+
/// <summary>
405+
/// Returns the hash code for this instance.
406+
/// </summary>
407+
/// <returns>A hash code for the current AmplitudeRatio.</returns>
398408
public override int GetHashCode()
399409
{
400410
return new { Value, Unit }.GetHashCode();
@@ -539,10 +549,10 @@ public static AmplitudeRatioUnit ParseUnit(string str, [CanBeNull] string cultur
539549

540550
#endregion
541551

542-
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
543552
/// <summary>
544553
/// Set the default unit used by ToString(). Default is DecibelVolt
545554
/// </summary>
555+
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
546556
public static AmplitudeRatioUnit ToStringDefaultUnit { get; set; } = AmplitudeRatioUnit.DecibelVolt;
547557

548558
/// <summary>

Common/GeneratedCode/Quantities/Angle.Common.g.cs

+11-1
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@ static Angle()
8181
{
8282
}
8383

84+
/// <summary>
85+
/// Creates the quantity with the given value in the base unit Degree.
86+
/// </summary>
8487
[Obsolete("Use the constructor that takes a unit parameter. This constructor will be removed in a future version.")]
8588
public Angle(double degrees)
8689
{
@@ -231,6 +234,9 @@ public static BaseDimensions BaseDimensions
231234

232235
#region Static
233236

237+
/// <summary>
238+
/// Gets an instance of this quantity with a value of 0 in the base unit Degree.
239+
/// </summary>
234240
public static Angle Zero => new Angle(0, BaseUnit);
235241

236242
/// <summary>
@@ -585,6 +591,10 @@ public bool Equals(Angle other, Angle maxError)
585591
return Math.Abs(_value - other.AsBaseNumericType(this.Unit)) <= maxError.AsBaseNumericType(this.Unit);
586592
}
587593

594+
/// <summary>
595+
/// Returns the hash code for this instance.
596+
/// </summary>
597+
/// <returns>A hash code for the current Angle.</returns>
588598
public override int GetHashCode()
589599
{
590600
return new { Value, Unit }.GetHashCode();
@@ -749,10 +759,10 @@ public static AngleUnit ParseUnit(string str, [CanBeNull] string cultureName)
749759

750760
#endregion
751761

752-
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
753762
/// <summary>
754763
/// Set the default unit used by ToString(). Default is Degree
755764
/// </summary>
765+
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
756766
public static AngleUnit ToStringDefaultUnit { get; set; } = AngleUnit.Degree;
757767

758768
/// <summary>

Common/GeneratedCode/Quantities/ApparentEnergy.Common.g.cs

+11-1
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ static ApparentEnergy()
8282
BaseDimensions = new BaseDimensions(2, 1, -2, 0, 0, 0, 0);
8383
}
8484

85+
/// <summary>
86+
/// Creates the quantity with the given value in the base unit VoltampereHour.
87+
/// </summary>
8588
[Obsolete("Use the constructor that takes a unit parameter. This constructor will be removed in a future version.")]
8689
public ApparentEnergy(double voltamperehours)
8790
{
@@ -177,6 +180,9 @@ public static BaseDimensions BaseDimensions
177180

178181
#region Static
179182

183+
/// <summary>
184+
/// Gets an instance of this quantity with a value of 0 in the base unit VoltampereHour.
185+
/// </summary>
180186
public static ApparentEnergy Zero => new ApparentEnergy(0, BaseUnit);
181187

182188
/// <summary>
@@ -377,6 +383,10 @@ public bool Equals(ApparentEnergy other, ApparentEnergy maxError)
377383
return Math.Abs(_value - other.AsBaseNumericType(this.Unit)) <= maxError.AsBaseNumericType(this.Unit);
378384
}
379385

386+
/// <summary>
387+
/// Returns the hash code for this instance.
388+
/// </summary>
389+
/// <returns>A hash code for the current ApparentEnergy.</returns>
380390
public override int GetHashCode()
381391
{
382392
return new { Value, Unit }.GetHashCode();
@@ -519,10 +529,10 @@ public static ApparentEnergyUnit ParseUnit(string str, [CanBeNull] string cultur
519529

520530
#endregion
521531

522-
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
523532
/// <summary>
524533
/// Set the default unit used by ToString(). Default is VoltampereHour
525534
/// </summary>
535+
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
526536
public static ApparentEnergyUnit ToStringDefaultUnit { get; set; } = ApparentEnergyUnit.VoltampereHour;
527537

528538
/// <summary>

Common/GeneratedCode/Quantities/ApparentPower.Common.g.cs

+11-1
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ static ApparentPower()
8282
BaseDimensions = new BaseDimensions(2, 1, -3, 0, 0, 0, 0);
8383
}
8484

85+
/// <summary>
86+
/// Creates the quantity with the given value in the base unit Voltampere.
87+
/// </summary>
8588
[Obsolete("Use the constructor that takes a unit parameter. This constructor will be removed in a future version.")]
8689
public ApparentPower(double voltamperes)
8790
{
@@ -182,6 +185,9 @@ public static BaseDimensions BaseDimensions
182185

183186
#region Static
184187

188+
/// <summary>
189+
/// Gets an instance of this quantity with a value of 0 in the base unit Voltampere.
190+
/// </summary>
185191
public static ApparentPower Zero => new ApparentPower(0, BaseUnit);
186192

187193
/// <summary>
@@ -396,6 +402,10 @@ public bool Equals(ApparentPower other, ApparentPower maxError)
396402
return Math.Abs(_value - other.AsBaseNumericType(this.Unit)) <= maxError.AsBaseNumericType(this.Unit);
397403
}
398404

405+
/// <summary>
406+
/// Returns the hash code for this instance.
407+
/// </summary>
408+
/// <returns>A hash code for the current ApparentPower.</returns>
399409
public override int GetHashCode()
400410
{
401411
return new { Value, Unit }.GetHashCode();
@@ -540,10 +550,10 @@ public static ApparentPowerUnit ParseUnit(string str, [CanBeNull] string culture
540550

541551
#endregion
542552

543-
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
544553
/// <summary>
545554
/// Set the default unit used by ToString(). Default is Voltampere
546555
/// </summary>
556+
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
547557
public static ApparentPowerUnit ToStringDefaultUnit { get; set; } = ApparentPowerUnit.Voltampere;
548558

549559
/// <summary>

Common/GeneratedCode/Quantities/Area.Common.g.cs

+11-1
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ static Area()
8282
BaseDimensions = new BaseDimensions(2, 0, 0, 0, 0, 0, 0);
8383
}
8484

85+
/// <summary>
86+
/// Creates the quantity with the given value in the base unit SquareMeter.
87+
/// </summary>
8588
[Obsolete("Use the constructor that takes a unit parameter. This constructor will be removed in a future version.")]
8689
public Area(double squaremeters)
8790
{
@@ -227,6 +230,9 @@ public static BaseDimensions BaseDimensions
227230

228231
#region Static
229232

233+
/// <summary>
234+
/// Gets an instance of this quantity with a value of 0 in the base unit SquareMeter.
235+
/// </summary>
230236
public static Area Zero => new Area(0, BaseUnit);
231237

232238
/// <summary>
@@ -567,6 +573,10 @@ public bool Equals(Area other, Area maxError)
567573
return Math.Abs(_value - other.AsBaseNumericType(this.Unit)) <= maxError.AsBaseNumericType(this.Unit);
568574
}
569575

576+
/// <summary>
577+
/// Returns the hash code for this instance.
578+
/// </summary>
579+
/// <returns>A hash code for the current Area.</returns>
570580
public override int GetHashCode()
571581
{
572582
return new { Value, Unit }.GetHashCode();
@@ -729,10 +739,10 @@ public static AreaUnit ParseUnit(string str, [CanBeNull] string cultureName)
729739

730740
#endregion
731741

732-
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
733742
/// <summary>
734743
/// Set the default unit used by ToString(). Default is SquareMeter
735744
/// </summary>
745+
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
736746
public static AreaUnit ToStringDefaultUnit { get; set; } = AreaUnit.SquareMeter;
737747

738748
/// <summary>

Common/GeneratedCode/Quantities/AreaDensity.Common.g.cs

+11-1
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ static AreaDensity()
8282
BaseDimensions = new BaseDimensions(-2, 1, 0, 0, 0, 0, 0);
8383
}
8484

85+
/// <summary>
86+
/// Creates the quantity with the given value in the base unit KilogramPerSquareMeter.
87+
/// </summary>
8588
[Obsolete("Use the constructor that takes a unit parameter. This constructor will be removed in a future version.")]
8689
public AreaDensity(double kilogramspersquaremeter)
8790
{
@@ -167,6 +170,9 @@ public static BaseDimensions BaseDimensions
167170

168171
#region Static
169172

173+
/// <summary>
174+
/// Gets an instance of this quantity with a value of 0 in the base unit KilogramPerSquareMeter.
175+
/// </summary>
170176
public static AreaDensity Zero => new AreaDensity(0, BaseUnit);
171177

172178
/// <summary>
@@ -339,6 +345,10 @@ public bool Equals(AreaDensity other, AreaDensity maxError)
339345
return Math.Abs(_value - other.AsBaseNumericType(this.Unit)) <= maxError.AsBaseNumericType(this.Unit);
340346
}
341347

348+
/// <summary>
349+
/// Returns the hash code for this instance.
350+
/// </summary>
351+
/// <returns>A hash code for the current AreaDensity.</returns>
342352
public override int GetHashCode()
343353
{
344354
return new { Value, Unit }.GetHashCode();
@@ -477,10 +487,10 @@ public static AreaDensityUnit ParseUnit(string str, [CanBeNull] string cultureNa
477487

478488
#endregion
479489

480-
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
481490
/// <summary>
482491
/// Set the default unit used by ToString(). Default is KilogramPerSquareMeter
483492
/// </summary>
493+
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
484494
public static AreaDensityUnit ToStringDefaultUnit { get; set; } = AreaDensityUnit.KilogramPerSquareMeter;
485495

486496
/// <summary>

Common/GeneratedCode/Quantities/AreaMomentOfInertia.Common.g.cs

+11-1
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ static AreaMomentOfInertia()
8282
BaseDimensions = new BaseDimensions(4, 0, 0, 0, 0, 0, 0);
8383
}
8484

85+
/// <summary>
86+
/// Creates the quantity with the given value in the base unit MeterToTheFourth.
87+
/// </summary>
8588
[Obsolete("Use the constructor that takes a unit parameter. This constructor will be removed in a future version.")]
8689
public AreaMomentOfInertia(double meterstothefourth)
8790
{
@@ -192,6 +195,9 @@ public static BaseDimensions BaseDimensions
192195

193196
#region Static
194197

198+
/// <summary>
199+
/// Gets an instance of this quantity with a value of 0 in the base unit MeterToTheFourth.
200+
/// </summary>
195201
public static AreaMomentOfInertia Zero => new AreaMomentOfInertia(0, BaseUnit);
196202

197203
/// <summary>
@@ -434,6 +440,10 @@ public bool Equals(AreaMomentOfInertia other, AreaMomentOfInertia maxError)
434440
return Math.Abs(_value - other.AsBaseNumericType(this.Unit)) <= maxError.AsBaseNumericType(this.Unit);
435441
}
436442

443+
/// <summary>
444+
/// Returns the hash code for this instance.
445+
/// </summary>
446+
/// <returns>A hash code for the current AreaMomentOfInertia.</returns>
437447
public override int GetHashCode()
438448
{
439449
return new { Value, Unit }.GetHashCode();
@@ -582,10 +592,10 @@ public static AreaMomentOfInertiaUnit ParseUnit(string str, [CanBeNull] string c
582592

583593
#endregion
584594

585-
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
586595
/// <summary>
587596
/// Set the default unit used by ToString(). Default is MeterToTheFourth
588597
/// </summary>
598+
[Obsolete("This is no longer used since we will instead use the quantity's Unit value as default.")]
589599
public static AreaMomentOfInertiaUnit ToStringDefaultUnit { get; set; } = AreaMomentOfInertiaUnit.MeterToTheFourth;
590600

591601
/// <summary>

0 commit comments

Comments
 (0)