Enable CS1570 and fix noncompliance

malformed XML
2020-06-21 05:47:47 +10:00 · 2020-06-21 05:47:47 +10:00 · f37b74c4ba
parent 43cc80f6a3
commit f37b74c4ba
17 changed files with 33 additions and 33 deletions
--- a/src/BizHawk.BizInvoke/MemoryBlock.cs
+++ b/src/BizHawk.BizInvoke/MemoryBlock.cs
@ -136,7 +136,7 @@ namespace BizHawk.BizInvoke
 			return _hash;
 		}

-		/// <summary>set r/w/x protection on a portion of memory. rounded to encompassing pages</summary
+		/// <summary>set r/w/x protection on a portion of memory. rounded to encompassing pages</summary>
 		/// <exception cref="InvalidOperationException">failed to protect memory</exception>
 		public void Protect(ulong start, ulong length, Protection prot)
 		{
--- a/src/BizHawk.Client.Common/lua/LuaHelper.cs
+++ b/src/BizHawk.Client.Common/lua/LuaHelper.cs
@ -16,7 +16,7 @@ namespace BizHawk.Client.Common
 		/// Lua numbers are always double-length floats, so integers whose magnitude is at least 2^53 may not fit in the 53-bit mantissa (the sign is stored separately).
 		/// These extremely large values aren't that useful, so we'll just assume they're erroneous and give the script author an error.
 		/// </remarks>
-		/// <exception cref="ArithmeticException"><paramref name="d"/> &ge; 2^53 or <paramref name="d"/> &le; -2^53</exception>
+		/// <exception cref="ArithmeticException"><paramref name="d"/> ≥ 2^53 or <paramref name="d"/> ≤ -2^53</exception>
 		public static long AsInteger(this double d) => PrecisionLimits.Contains(d) ? (long) d : throw new ArithmeticException("integer value exceeds the precision of Lua's integer-as-double");

 		public static LuaTable EnumerateToLuaTable<T>(this IEnumerable<T> list, Lua lua) => list.ToList().ToLuaTable(lua);
--- a/src/BizHawk.Client.EmuHawk/AVOut/Quantize/OctreeQuantizer.cs
+++ b/src/BizHawk.Client.EmuHawk/AVOut/Quantize/OctreeQuantizer.cs
@ -40,7 +40,7 @@ namespace BizHawk.Client.EmuHawk

 		/// <param name="maxColors">The maximum number of colors to return</param>
 		/// <param name="maxColorBits">The number of significant bits</param>
-		/// <exception cref="ArgumentOutOfRangeException"><paramref name="maxColors"/> &ge; <c>256</c> or <paramref name="maxColorBits"/> outside range <c>1..8</c></exception>
+		/// <exception cref="ArgumentOutOfRangeException"><paramref name="maxColors"/> ≥ <c>256</c> or <paramref name="maxColorBits"/> outside range <c>1..8</c></exception>
 		/// <remarks>The Octree quantizer is a two pass algorithm. The initial pass sets up the octree, the second pass quantizes a color based on the nodes in the tree.</remarks>
 		public OctreeQuantizer(int maxColors, int maxColorBits) : base(false)
 		{
--- a/src/BizHawk.Client.EmuHawk/Input/OTK_Gamepad.cs
+++ b/src/BizHawk.Client.EmuHawk/Input/OTK_Gamepad.cs
@ -11,7 +11,7 @@ namespace BizHawk.Client.EmuHawk
 	/// <summary>
 	/// Modified OpenTK Gamepad Handler<br/>
 	/// The jump from OpenTK 1.x to 3.x broke the original <see cref="Joystick">OpenTK.Input.Joystick</see> implementation, but we gain <see cref="OpenTKGamePad">OpenTK.Input.GamePad</see> support on Unix. However, the gamepad auto-mapping is a little suspect, so we use both methods.<br/>
-	/// As a side-effect, it should make it easier to implement virtual&rarr;host haptics in the future.
+	/// As a side-effect, it should make it easier to implement virtual→host haptics in the future.
 	/// </summary>
 	public class OTK_GamePad
 	{
--- a/src/BizHawk.Common/HawkFile/HawkFile.cs
+++ b/src/BizHawk.Common/HawkFile/HawkFile.cs
@ -62,7 +62,7 @@ namespace BizHawk.Common

 		public readonly bool IsArchive;

-		/// <summary>Indicates whether the file is an archive member (IsArchive && IsBound[to member])</summary>
+		/// <summary>Indicates whether the file is an archive member (IsArchive &amp;&amp; IsBound[to member])</summary>
 		public bool IsArchiveMember => IsArchive && IsBound;

 		/// <summary>Gets a value indicating whether this instance is bound</summary>
--- a/src/BizHawk.Common/Ranges.cs
+++ b/src/BizHawk.Common/Ranges.cs
@ -6,7 +6,7 @@ using BizHawk.Common.NumberExtensions;

 namespace BizHawk.Common
 {
-	/// <summary>represents a closed range of <typeparamref name="T"/> (class invariant: <see cref="Start"/> &le; <see cref="EndInclusive"/>)</summary>
+	/// <summary>represents a closed range of <typeparamref name="T"/> (class invariant: <see cref="Start"/> ≤ <see cref="EndInclusive"/>)</summary>
 	public interface Range<out T> where T : unmanaged, IComparable<T>
 	{
 		T Start { get; }
@ -14,7 +14,7 @@ namespace BizHawk.Common
 		T EndInclusive { get; }
 	}

-	/// <summary>represents a closed range of <typeparamref name="T"/> which can be grown or shrunk (class invariant: <see cref="Start"/> &le; <see cref="EndInclusive"/>)</summary>
+	/// <summary>represents a closed range of <typeparamref name="T"/> which can be grown or shrunk (class invariant: <see cref="Start"/> ≤ <see cref="EndInclusive"/>)</summary>
 	public class MutableRange<T> : Range<T> where T : unmanaged, IComparable<T>
 	{
 		private (T Start, T EndInclusive) r;
@ -224,8 +224,8 @@ namespace BizHawk.Common
 		/// <inheritdoc cref="RangeToExclusive(int,int)"/>
 		public static Range<byte> RangeToExclusive(this byte start, byte endExclusive) => MutableRangeToExclusive(start, endExclusive);

-		/// <exception cref="ArgumentOutOfRangeException"><paramref name="endExclusive"/> &le; <paramref name="start"/> (empty ranges where <paramref name="start"/> = <paramref name="endExclusive"/> are not permitted)</exception>
-		/// <exception cref="ArithmeticException"><paramref name="endExclusive"/> is min value of integral type (therefore <paramref name="endExclusive"/> &le; <paramref name="start"/>)</exception>
+		/// <exception cref="ArgumentOutOfRangeException"><paramref name="endExclusive"/> ≤ <paramref name="start"/> (empty ranges where <paramref name="start"/> = <paramref name="endExclusive"/> are not permitted)</exception>
+		/// <exception cref="ArithmeticException"><paramref name="endExclusive"/> is min value of integral type (therefore <paramref name="endExclusive"/> ≤ <paramref name="start"/>)</exception>
 		public static Range<int> RangeToExclusive(this int start, int endExclusive) => MutableRangeToExclusive(start, endExclusive);

 		/// <inheritdoc cref="RangeToExclusive(int,int)"/>
--- a/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Abstraction/IPortIODevice.cs
+++ b/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Abstraction/IPortIODevice.cs
@ -2,7 +2,7 @@
 namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 {
 	/// <summary>
-	/// Represents a device that utilizes port IN & OUT
+	/// Represents a device that utilizes port IN &amp; OUT
 	/// </summary>
 	public interface IPortIODevice
 	{
--- a/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Disk/NECUPD765.Definitions.cs
+++ b/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Disk/NECUPD765.Definitions.cs
@ -250,7 +250,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 			ST3,
 			/// <summary>
 			/// 1 byte returned - ST0
-			/// (used for version & invalid)
+			/// (used for version &amp; invalid)
 			/// </summary>
 			ST0,
 			/// <summary>
--- a/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Display/AmstradGateArray.cs
+++ b/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Display/AmstradGateArray.cs
@ -1322,7 +1322,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 			/// </summary>
 			Amstrad40226,
 			/// <summary>
-			/// Plus & GX-4000
+			/// Plus &amp; GX-4000
 			/// All the Plus range is built upon a bigger ASIC chip which is integrating many features of the classic CPC (FDC, CRTC, PPI, Gate Array/PAL) and all 
 			/// the new Plus specific features. The Gate Array on the Plus have a new register, named RMR2, to expand the ROM mapping functionnalities of the machine. 
 			/// This register requires to be unlocked first to be available. And finally, the RGB levels produced by the ASIC on the Plus are noticeably differents
--- a/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Display/CRCT_6845.cs
+++ b/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Display/CRCT_6845.cs
@ -325,7 +325,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 		/// R13:    Display Start Address (Low)
 		/// Unit:   
 		/// Notes:  Define the LSB of MA when a CRTC-screen starts
-		///         Allows you to offset the start of screen memory for hardware scrolling, and if using memory from address &0000 with the firmware.
+		///         Allows you to offset the start of screen memory for hardware scrolling, and if using memory from address &amp;0000 with the firmware.
 		/// </summary>
 		public const int DISP_START_ADDR_L = 13;
 		/// <summary>
--- a/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Display/CRTC6845.cs
+++ b/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Display/CRTC6845.cs
@ -24,7 +24,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 	/// Datasheet:    http://www.cpcwiki.eu/imgs/b/b5/Um6845r.umc.pdf
 	/// ------------------------------------------------------------------------------------------------------
 	/// MC6845        Motorola        2
-	/// Datasheet:    http://www.cpcwiki.eu/imgs/d/da/Mc6845.motorola.pdf & http://bitsavers.trailing-edge.com/components/motorola/_dataSheets/6845.pdf
+	/// Datasheet:    http://www.cpcwiki.eu/imgs/d/da/Mc6845.motorola.pdf &amp; http://bitsavers.trailing-edge.com/components/motorola/_dataSheets/6845.pdf
 	/// ------------------------------------------------------------------------------------------------------
 	/// AMS40489      Amstrad         3           Only exists in the CPC464+, CPC6128+ and GX4000 and is integrated into a single CPC+ ASIC chip (along with the gatearray)
 	/// Datasheet:    {none}
@ -272,7 +272,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 		}

 		/// <summary>
-		/// The CRTC latches the Display Start H & L address at different times
+		/// The CRTC latches the Display Start H &amp; L address at different times
 		/// (depending on the chip type)
 		/// </summary>
 		private int StartAddressLatch;
@ -628,7 +628,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 		}

 		/// <summary>
-		/// Gets the combined value of R12 & R13
+		/// Gets the combined value of R12 &amp; R13
 		/// </summary>
 		private int StartAddressRegisterValue
 		{
@ -641,7 +641,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 		}

 		/// <summary>
-		/// Gets the combined value of R14 & R15
+		/// Gets the combined value of R14 &amp; R15
 		/// </summary>
 		private int CursorAddressRegisterValue
 		{
@ -654,14 +654,14 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 		}

 		/// <summary>
-		/// Current programmed HSYNC width for Type 0 (HD6845S & UM6845) & Type 1 (UM6845R)
+		/// Current programmed HSYNC width for Type 0 (HD6845S &amp; UM6845) &amp; Type 1 (UM6845R)
 		/// </summary>
 		// Bits 3..0 define Horizontal Sync Width. 
 		// If 0 is programmed no HSYNC is generated.
 		private int HSYNCWidth_Type0_1 => (Register[SYNC_WIDTHS] >> 0) & 0x0F;

 		/// <summary>
-		/// Current programmed HSYNC width for Type 2 (MC6845), 3 (AMS40489) & 4 (pre-ASIC)
+		/// Current programmed HSYNC width for Type 2 (MC6845), 3 (AMS40489) &amp; 4 (pre-ASIC)
 		/// </summary>
 		private int HSYNCWidth_Type2_3_4
 		{
@ -677,7 +677,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 		}

 		/// <summary>
-		/// Current programmed VSYNC width for Type 0 (HD6845S & UM6845), 3 (AMS40489) & 4 (pre-ASIC)
+		/// Current programmed VSYNC width for Type 0 (HD6845S &amp; UM6845), 3 (AMS40489) &amp; 4 (pre-ASIC)
 		/// </summary>
 		private int VSYNCWidth_Type0_3_4
 		{
@ -693,14 +693,14 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 		}

 		/// <summary>
-		/// Current programmed VSYNC width for Type 1 (UM6845R) & 2 (MC6845)
+		/// Current programmed VSYNC width for Type 1 (UM6845R) &amp; 2 (MC6845)
 		/// </summary>
 		// Bits 7..4 are ignored. 
 		// Vertical Sync is fixed at 16 lines.
 		private int VSYNCWidth_Type1_2 => 16;

 		/// <summary>
-		/// Read Register (HD6845S & UM6845)
+		/// Read Register (HD6845S &amp; UM6845)
 		/// </summary>
 		private bool ReadRegister_Type0(ref int data)
 		{
@ -854,7 +854,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 		}

 		/// <summary>
-		/// Read Register (AMS40489 & pre-ASIC)
+		/// Read Register (AMS40489 &amp; pre-ASIC)
 		/// </summary>
 		private bool ReadRegister_Type3_4(ref int data)
 		{
@ -920,7 +920,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 		}

 		/// <summary>
-		/// Write Active Register (HD6845S & UM6845)
+		/// Write Active Register (HD6845S &amp; UM6845)
 		/// </summary>
 		private void WriteRegister_Type0(int data)
 		{
@ -957,7 +957,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 		}

 		/// <summary>
-		/// Write Active Register (HD6845S & UM6845)
+		/// Write Active Register (HD6845S &amp; UM6845)
 		/// </summary>
 		private void WriteRegister_Type1(int data)
 		{
@ -1085,7 +1085,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 		}

 		/// <summary>
-		/// Read Status Register (HD6845S & UM6845)
+		/// Read Status Register (HD6845S &amp; UM6845)
 		/// No status register available
 		/// </summary>
 		private bool ReadStatus_Unavailable(ref int data)
@ -2179,7 +2179,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 		private const int CURSOR_H = 14;
 		private const int CURSOR_L = 15;
 		/// <summary>
-		/// This 14 bit read -only register is used to store the contents of the Address Register(H & L) when the LPSTB input pulses high.
+		/// This 14 bit read -only register is used to store the contents of the Address Register(H &amp; L) when the LPSTB input pulses high.
 		/// This register consists of an 8 bit lower and 6 bit higher register.
 		/// </summary>
 		private const int LIGHT_PEN_H = 16;
--- a/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Machine/CPCBase.cs
+++ b/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Machine/CPCBase.cs
@ -112,7 +112,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC
 		public bool _renderSound;

 		/// <summary>
-		/// Mask constants & misc
+		/// Mask constants &amp; misc
 		/// </summary>
 		protected const int BORDER_BIT = 0x07;
 		protected const int EAR_BIT = 0x10;
--- a/src/BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Hardware/Abstraction/IPortIODevice.cs
+++ b/src/BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Hardware/Abstraction/IPortIODevice.cs
@ -2,7 +2,7 @@
 namespace BizHawk.Emulation.Cores.Computers.SinclairSpectrum
 {
 	/// <summary>
-	/// Represents a device that utilizes port IN & OUT
+	/// Represents a device that utilizes port IN &amp; OUT
 	/// </summary>
 	public interface IPortIODevice
 	{
--- a/src/BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Hardware/Disk/NECUPD765.Definitions.cs
+++ b/src/BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Hardware/Disk/NECUPD765.Definitions.cs
@ -250,7 +250,7 @@ namespace BizHawk.Emulation.Cores.Computers.SinclairSpectrum
            ST3,
            /// <summary>
            /// 1 byte returned - ST0
-            /// (used for version & invalid)
+            /// (used for version &amp; invalid)
            /// </summary>
            ST0,
            /// <summary>
--- a/src/BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Machine/SpectrumBase.cs
+++ b/src/BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Machine/SpectrumBase.cs
@ -113,7 +113,7 @@ namespace BizHawk.Emulation.Cores.Computers.SinclairSpectrum
 		public bool _renderSound;

 		/// <summary>
-		/// Mask constants & misc
+		/// Mask constants &amp; misc
 		/// </summary>
 		protected const int BORDER_BIT = 0x07;
 		protected const int EAR_BIT = 0x10;
--- a/src/BizHawk.Emulation.Cores/Consoles/Fairchild/ChannelF/Video.cs
+++ b/src/BizHawk.Emulation.Cores/Consoles/Fairchild/ChannelF/Video.cs
@ -9,7 +9,7 @@ namespace BizHawk.Emulation.Cores.Consoles.ChannelF
 	{
 		/// <summary>
 		/// 128x64 pixels - 8192x2bits (2 KB)
-		/// For the purposes of this core we will use 8192 bytes and just & 0x03
+		/// For the purposes of this core we will use 8192 bytes and just &amp; 0x03
 		/// </summary>
 		public byte[] VRAM = new byte[(128 * 64)];

--- a/src/MainSlnCommon.props
+++ b/src/MainSlnCommon.props
@ -5,7 +5,7 @@
 		<CodeAnalysisRuleSet>$(ProjectDir)../../Common.ruleset</CodeAnalysisRuleSet>
 		<DocumentationFile>$(ProjectDir)bin/doc_comments.xml</DocumentationFile>
 		<MSBuildWarningsAsMessages>NU1702</MSBuildWarningsAsMessages>
-		<NoWarn>CS1570;CS1572;CS1573;CS1574;CS1591;CS1734;NU1701</NoWarn>
+		<NoWarn>CS1572;CS1573;CS1574;CS1591;CS1734;NU1701</NoWarn>
 		<OutputPath>$(ProjectDir)../../output/dll</OutputPath>
 	</PropertyGroup>
 	<ItemGroup>