From f37b74c4ba05a386b013a28499b9fdcdff782d82 Mon Sep 17 00:00:00 2001 From: YoshiRulz Date: Sun, 21 Jun 2020 05:47:47 +1000 Subject: [PATCH] Enable CS1570 and fix noncompliance malformed XML --- src/BizHawk.BizInvoke/MemoryBlock.cs | 2 +- src/BizHawk.Client.Common/lua/LuaHelper.cs | 2 +- .../AVOut/Quantize/OctreeQuantizer.cs | 2 +- .../Input/OTK_Gamepad.cs | 2 +- src/BizHawk.Common/HawkFile/HawkFile.cs | 2 +- src/BizHawk.Common/Ranges.cs | 8 +++--- .../Hardware/Abstraction/IPortIODevice.cs | 2 +- .../Hardware/Disk/NECUPD765.Definitions.cs | 2 +- .../Hardware/Display/AmstradGateArray.cs | 2 +- .../AmstradCPC/Hardware/Display/CRCT_6845.cs | 2 +- .../AmstradCPC/Hardware/Display/CRTC6845.cs | 28 +++++++++---------- .../Computers/AmstradCPC/Machine/CPCBase.cs | 2 +- .../Hardware/Abstraction/IPortIODevice.cs | 2 +- .../Hardware/Disk/NECUPD765.Definitions.cs | 2 +- .../SinclairSpectrum/Machine/SpectrumBase.cs | 2 +- .../Consoles/Fairchild/ChannelF/Video.cs | 2 +- src/MainSlnCommon.props | 2 +- 17 files changed, 33 insertions(+), 33 deletions(-) diff --git a/src/BizHawk.BizInvoke/MemoryBlock.cs b/src/BizHawk.BizInvoke/MemoryBlock.cs index fe8a866158..bc259f8aeb 100644 --- a/src/BizHawk.BizInvoke/MemoryBlock.cs +++ b/src/BizHawk.BizInvoke/MemoryBlock.cs @@ -136,7 +136,7 @@ namespace BizHawk.BizInvoke return _hash; } - /// set r/w/x protection on a portion of memory. rounded to encompassing pagesset r/w/x protection on a portion of memory. rounded to encompassing pages /// failed to protect memory public void Protect(ulong start, ulong length, Protection prot) { diff --git a/src/BizHawk.Client.Common/lua/LuaHelper.cs b/src/BizHawk.Client.Common/lua/LuaHelper.cs index 0eb79f844b..f5c705f880 100644 --- 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. /// - /// ≥ 2^53 or ≤ -2^53 + /// ≥ 2^53 or ≤ -2^53 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(this IEnumerable list, Lua lua) => list.ToList().ToLuaTable(lua); diff --git a/src/BizHawk.Client.EmuHawk/AVOut/Quantize/OctreeQuantizer.cs b/src/BizHawk.Client.EmuHawk/AVOut/Quantize/OctreeQuantizer.cs index b58f0d223b..79595b131b 100644 --- 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 /// The maximum number of colors to return /// The number of significant bits - /// ≥ 256 or outside range 1..8 + /// ≥ 256 or outside range 1..8 /// 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. public OctreeQuantizer(int maxColors, int maxColorBits) : base(false) { diff --git a/src/BizHawk.Client.EmuHawk/Input/OTK_Gamepad.cs b/src/BizHawk.Client.EmuHawk/Input/OTK_Gamepad.cs index 6b4ad1a640..7e070434e8 100644 --- 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 /// /// Modified OpenTK Gamepad Handler
/// The jump from OpenTK 1.x to 3.x broke the original OpenTK.Input.Joystick implementation, but we gain OpenTK.Input.GamePad support on Unix. However, the gamepad auto-mapping is a little suspect, so we use both methods.
- /// As a side-effect, it should make it easier to implement virtual→host haptics in the future. + /// As a side-effect, it should make it easier to implement virtual→host haptics in the future. /// public class OTK_GamePad { diff --git a/src/BizHawk.Common/HawkFile/HawkFile.cs b/src/BizHawk.Common/HawkFile/HawkFile.cs index 7677308dcb..ff99b48206 100644 --- 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; - /// Indicates whether the file is an archive member (IsArchive && IsBound[to member]) + /// Indicates whether the file is an archive member (IsArchive && IsBound[to member]) public bool IsArchiveMember => IsArchive && IsBound; /// Gets a value indicating whether this instance is bound diff --git a/src/BizHawk.Common/Ranges.cs b/src/BizHawk.Common/Ranges.cs index e7a427be91..8a9090993d 100644 --- a/src/BizHawk.Common/Ranges.cs +++ b/src/BizHawk.Common/Ranges.cs @@ -6,7 +6,7 @@ using BizHawk.Common.NumberExtensions; namespace BizHawk.Common { - /// represents a closed range of (class invariant: ≤ ) + /// represents a closed range of (class invariant: ≤ ) public interface Range where T : unmanaged, IComparable { T Start { get; } @@ -14,7 +14,7 @@ namespace BizHawk.Common T EndInclusive { get; } } - /// represents a closed range of which can be grown or shrunk (class invariant: ≤ ) + /// represents a closed range of which can be grown or shrunk (class invariant: ≤ ) public class MutableRange : Range where T : unmanaged, IComparable { private (T Start, T EndInclusive) r; @@ -224,8 +224,8 @@ namespace BizHawk.Common /// public static Range RangeToExclusive(this byte start, byte endExclusive) => MutableRangeToExclusive(start, endExclusive); - /// ≤ (empty ranges where = are not permitted) - /// is min value of integral type (therefore ≤ ) + /// ≤ (empty ranges where = are not permitted) + /// is min value of integral type (therefore ≤ ) public static Range RangeToExclusive(this int start, int endExclusive) => MutableRangeToExclusive(start, endExclusive); /// diff --git a/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Abstraction/IPortIODevice.cs b/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Abstraction/IPortIODevice.cs index b71e08ee08..e89a278a2c 100644 --- 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 { /// - /// Represents a device that utilizes port IN & OUT + /// Represents a device that utilizes port IN & OUT /// public interface IPortIODevice { diff --git a/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Disk/NECUPD765.Definitions.cs b/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Disk/NECUPD765.Definitions.cs index aaef0d92b6..576f8886c4 100644 --- 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, /// /// 1 byte returned - ST0 - /// (used for version & invalid) + /// (used for version & invalid) /// ST0, /// diff --git a/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Display/AmstradGateArray.cs b/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Display/AmstradGateArray.cs index 7b2fd48e9d..7e746fbbb9 100644 --- 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 /// Amstrad40226, /// - /// Plus & GX-4000 + /// Plus & 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 diff --git a/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Display/CRCT_6845.cs b/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Display/CRCT_6845.cs index 1a9ba61bad..8ea7367061 100644 --- 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 &0000 with the firmware. /// public const int DISP_START_ADDR_L = 13; /// diff --git a/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Display/CRTC6845.cs b/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Hardware/Display/CRTC6845.cs index 20bbc6d21b..2414196903 100644 --- 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 & 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 } /// - /// The CRTC latches the Display Start H & L address at different times + /// The CRTC latches the Display Start H & L address at different times /// (depending on the chip type) /// private int StartAddressLatch; @@ -628,7 +628,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC } /// - /// Gets the combined value of R12 & R13 + /// Gets the combined value of R12 & R13 /// private int StartAddressRegisterValue { @@ -641,7 +641,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC } /// - /// Gets the combined value of R14 & R15 + /// Gets the combined value of R14 & R15 /// private int CursorAddressRegisterValue { @@ -654,14 +654,14 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC } /// - /// Current programmed HSYNC width for Type 0 (HD6845S & UM6845) & Type 1 (UM6845R) + /// Current programmed HSYNC width for Type 0 (HD6845S & UM6845) & Type 1 (UM6845R) /// // 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; /// - /// Current programmed HSYNC width for Type 2 (MC6845), 3 (AMS40489) & 4 (pre-ASIC) + /// Current programmed HSYNC width for Type 2 (MC6845), 3 (AMS40489) & 4 (pre-ASIC) /// private int HSYNCWidth_Type2_3_4 { @@ -677,7 +677,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC } /// - /// Current programmed VSYNC width for Type 0 (HD6845S & UM6845), 3 (AMS40489) & 4 (pre-ASIC) + /// Current programmed VSYNC width for Type 0 (HD6845S & UM6845), 3 (AMS40489) & 4 (pre-ASIC) /// private int VSYNCWidth_Type0_3_4 { @@ -693,14 +693,14 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC } /// - /// Current programmed VSYNC width for Type 1 (UM6845R) & 2 (MC6845) + /// Current programmed VSYNC width for Type 1 (UM6845R) & 2 (MC6845) /// // Bits 7..4 are ignored. // Vertical Sync is fixed at 16 lines. private int VSYNCWidth_Type1_2 => 16; /// - /// Read Register (HD6845S & UM6845) + /// Read Register (HD6845S & UM6845) /// private bool ReadRegister_Type0(ref int data) { @@ -854,7 +854,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC } /// - /// Read Register (AMS40489 & pre-ASIC) + /// Read Register (AMS40489 & pre-ASIC) /// private bool ReadRegister_Type3_4(ref int data) { @@ -920,7 +920,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC } /// - /// Write Active Register (HD6845S & UM6845) + /// Write Active Register (HD6845S & UM6845) /// private void WriteRegister_Type0(int data) { @@ -957,7 +957,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC } /// - /// Write Active Register (HD6845S & UM6845) + /// Write Active Register (HD6845S & UM6845) /// private void WriteRegister_Type1(int data) { @@ -1085,7 +1085,7 @@ namespace BizHawk.Emulation.Cores.Computers.AmstradCPC } /// - /// Read Status Register (HD6845S & UM6845) + /// Read Status Register (HD6845S & UM6845) /// No status register available /// 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; /// - /// 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 & L) when the LPSTB input pulses high. /// This register consists of an 8 bit lower and 6 bit higher register. /// private const int LIGHT_PEN_H = 16; diff --git a/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Machine/CPCBase.cs b/src/BizHawk.Emulation.Cores/Computers/AmstradCPC/Machine/CPCBase.cs index 0b29565118..a8129c7154 100644 --- 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; /// - /// Mask constants & misc + /// Mask constants & misc /// protected const int BORDER_BIT = 0x07; protected const int EAR_BIT = 0x10; diff --git a/src/BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Hardware/Abstraction/IPortIODevice.cs b/src/BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Hardware/Abstraction/IPortIODevice.cs index 7a24c2d1ba..9a304d9bdb 100644 --- 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 { /// - /// Represents a device that utilizes port IN & OUT + /// Represents a device that utilizes port IN & OUT /// public interface IPortIODevice { diff --git a/src/BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Hardware/Disk/NECUPD765.Definitions.cs b/src/BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Hardware/Disk/NECUPD765.Definitions.cs index 7e0c9f09f1..fb58a807d8 100644 --- 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, /// /// 1 byte returned - ST0 - /// (used for version & invalid) + /// (used for version & invalid) /// ST0, /// diff --git a/src/BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Machine/SpectrumBase.cs b/src/BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Machine/SpectrumBase.cs index 57a418cd31..7df1e0ac16 100644 --- 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; /// - /// Mask constants & misc + /// Mask constants & misc /// protected const int BORDER_BIT = 0x07; protected const int EAR_BIT = 0x10; diff --git a/src/BizHawk.Emulation.Cores/Consoles/Fairchild/ChannelF/Video.cs b/src/BizHawk.Emulation.Cores/Consoles/Fairchild/ChannelF/Video.cs index 8a54cd7603..20d2591aef 100644 --- 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 { /// /// 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 & 0x03 /// public byte[] VRAM = new byte[(128 * 64)]; diff --git a/src/MainSlnCommon.props b/src/MainSlnCommon.props index b020bf5b4c..d644156e98 100644 --- a/src/MainSlnCommon.props +++ b/src/MainSlnCommon.props @@ -5,7 +5,7 @@ $(ProjectDir)../../Common.ruleset $(ProjectDir)bin/doc_comments.xml NU1702 - CS1570;CS1572;CS1573;CS1574;CS1591;CS1734;NU1701 + CS1572;CS1573;CS1574;CS1591;CS1734;NU1701 $(ProjectDir)../../output/dll