From 135490c74065f39c977707cfcfd581dc9197b0d2 Mon Sep 17 00:00:00 2001 From: YoshiRulz Date: Sun, 21 Jun 2020 06:31:50 +1000 Subject: [PATCH] Enable CS1572, CS1574, and CS1734, and fix noncompliance malformed references or wrong XML tag --- src/BizHawk.Client.Common/SharpCompressDearchivalMethod.cs | 2 +- src/BizHawk.Client.Common/config/ToolDialogSettings.cs | 2 +- src/BizHawk.Client.Common/inputAdapters/InputManager.cs | 2 +- src/BizHawk.Client.Common/movie/interfaces/IMovie.cs | 2 +- src/BizHawk.Client.EmuHawk/AVOut/AVSync.cs | 2 +- src/BizHawk.Client.EmuHawk/AVOut/NutMuxer.cs | 4 ++-- .../GraphicsImplementations/IGL_SlimDX9.cs | 2 +- .../tools/Lua/DelegatingLuaLibraryEmu.cs | 2 +- src/BizHawk.Common/CustomCollections.cs | 2 +- src/BizHawk.Common/HawkFile/HawkArchiveFileItem.cs | 2 +- src/BizHawk.Common/HawkFile/HawkFile.cs | 2 +- src/BizHawk.Common/HawkFile/IHawkArchiveFile.cs | 2 +- src/BizHawk.Common/Util.cs | 2 +- src/BizHawk.Emulation.Common/Interfaces/IEmulator.cs | 2 +- src/BizHawk.Emulation.Cores/Computers/MSX/LibMSX.cs | 5 ++--- .../Consoles/Nintendo/Gameboy/LibGambatte.cs | 2 +- src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64.cs | 2 +- .../Consoles/Nintendo/N64/N64Audio.cs | 1 - .../Consoles/Nintendo/N64/N64VideoProvider.cs | 1 - src/BizHawk.Emulation.Cores/Sound/SyncSoundMixer.cs | 2 -- src/BizHawk.Emulation.Cores/Sound/VRC6Alt.cs | 1 - src/BizHawk.Emulation.DiscSystem/Internal/SynthUtils.cs | 2 +- src/BizHawk.WinForms.Controls/Docs.cs | 4 ++-- src/MainSlnCommon.props | 2 +- 24 files changed, 23 insertions(+), 29 deletions(-) diff --git a/src/BizHawk.Client.Common/SharpCompressDearchivalMethod.cs b/src/BizHawk.Client.Common/SharpCompressDearchivalMethod.cs index acdacd62b2..60afa99714 100644 --- a/src/BizHawk.Client.Common/SharpCompressDearchivalMethod.cs +++ b/src/BizHawk.Client.Common/SharpCompressDearchivalMethod.cs @@ -11,7 +11,7 @@ using SharpCompress.Common; namespace BizHawk.Client.Common { - /// A dearchival method for implemented using SharpCompress from NuGet. + /// A dearchival method for implemented using SharpCompress from NuGet. public class SharpCompressDearchivalMethod : IFileDearchivalMethod { private SharpCompressDearchivalMethod() {} diff --git a/src/BizHawk.Client.Common/config/ToolDialogSettings.cs b/src/BizHawk.Client.Common/config/ToolDialogSettings.cs index 4323fe5229..5c2304af1b 100644 --- a/src/BizHawk.Client.Common/config/ToolDialogSettings.cs +++ b/src/BizHawk.Client.Common/config/ToolDialogSettings.cs @@ -56,7 +56,7 @@ namespace BizHawk.Client.Common } } - /// the top-left corner of the , equivalent to the combined values of and + /// the top-left corner of the , equivalent to the combined values of and /// either or is null (it is expected to check for this before using this property) [JsonIgnore] public Point TopLeft diff --git a/src/BizHawk.Client.Common/inputAdapters/InputManager.cs b/src/BizHawk.Client.Common/inputAdapters/InputManager.cs index 17987f6efa..eccf2f3cf8 100644 --- a/src/BizHawk.Client.Common/inputAdapters/InputManager.cs +++ b/src/BizHawk.Client.Common/inputAdapters/InputManager.cs @@ -31,7 +31,7 @@ namespace BizHawk.Client.Common public StickyXorAdapter StickyXorAdapter { get; } = new StickyXorAdapter(); /// - /// Used to AND to another controller, used for JoypadApi.Set + /// Used to AND to another controller, used for JoypadApi.Set /// public OverrideAdapter ButtonOverrideAdapter { get; } = new OverrideAdapter(); diff --git a/src/BizHawk.Client.Common/movie/interfaces/IMovie.cs b/src/BizHawk.Client.Common/movie/interfaces/IMovie.cs index f90e7cb533..b7cd72d56e 100644 --- a/src/BizHawk.Client.Common/movie/interfaces/IMovie.cs +++ b/src/BizHawk.Client.Common/movie/interfaces/IMovie.cs @@ -284,7 +284,7 @@ namespace BizHawk.Client.Common } /// - /// Sets the given save ram if the movie contains save ram + /// Sets the given save ram if the movie contains save ram /// and the core supports save ram /// public static void ProcessSram(this IMovie movie, IEmulator emulator) diff --git a/src/BizHawk.Client.EmuHawk/AVOut/AVSync.cs b/src/BizHawk.Client.EmuHawk/AVOut/AVSync.cs index 12b9bc4cd9..8448072c89 100644 --- a/src/BizHawk.Client.EmuHawk/AVOut/AVSync.cs +++ b/src/BizHawk.Client.EmuHawk/AVOut/AVSync.cs @@ -17,7 +17,7 @@ namespace BizHawk.Client.EmuHawk /// /// 's mode is not , or - /// A/V parameters haven't been set (need to call and ) + /// A/V parameters haven't been set (need to call and ) /// public void DumpAV(IVideoProvider v, ISoundProvider asyncSoundProvider, out short[] samples, out int samplesProvided) { diff --git a/src/BizHawk.Client.EmuHawk/AVOut/NutMuxer.cs b/src/BizHawk.Client.EmuHawk/AVOut/NutMuxer.cs index bfc473132f..7ceb6034cd 100644 --- a/src/BizHawk.Client.EmuHawk/AVOut/NutMuxer.cs +++ b/src/BizHawk.Client.EmuHawk/AVOut/NutMuxer.cs @@ -541,7 +541,7 @@ namespace BizHawk.Client.EmuHawk } /// write a video frame to the stream - /// raw video data; if length 0, write EOR + /// raw video data; if length 0, write EOR /// internal error, possible A/V desync /// already written EOR public void WriteVideoFrame(int[] video) @@ -569,7 +569,7 @@ namespace BizHawk.Client.EmuHawk } /// write an audio frame to the stream - /// raw audio data; if length 0, write EOR + /// raw audio data; if length 0, write EOR /// internal error, possible A/V desync /// already written EOR public void WriteAudioFrame(short[] samples) diff --git a/src/BizHawk.Client.EmuHawk/GraphicsImplementations/IGL_SlimDX9.cs b/src/BizHawk.Client.EmuHawk/GraphicsImplementations/IGL_SlimDX9.cs index bc1fd1e5a2..2591c6bc09 100644 --- a/src/BizHawk.Client.EmuHawk/GraphicsImplementations/IGL_SlimDX9.cs +++ b/src/BizHawk.Client.EmuHawk/GraphicsImplementations/IGL_SlimDX9.cs @@ -325,7 +325,7 @@ namespace BizHawk.Client.EmuHawk /// /// is and either or is unavailable (their property is ), or - /// one of 's items has an unsupported value in , , or + /// one of 's items has an unsupported value in , , or /// public Pipeline CreatePipeline(VertexLayout vertexLayout, Shader vertexShader, Shader fragmentShader, bool required, string memo) { diff --git a/src/BizHawk.Client.EmuHawk/tools/Lua/DelegatingLuaLibraryEmu.cs b/src/BizHawk.Client.EmuHawk/tools/Lua/DelegatingLuaLibraryEmu.cs index 25c9a00605..dc9f0c13e7 100644 --- a/src/BizHawk.Client.EmuHawk/tools/Lua/DelegatingLuaLibraryEmu.cs +++ b/src/BizHawk.Client.EmuHawk/tools/Lua/DelegatingLuaLibraryEmu.cs @@ -6,7 +6,7 @@ using BizHawk.Client.Common; namespace BizHawk.Client.EmuHawk { - /// As , but also includes EmuHawk APIs via a . + /// As , but also includes EmuHawk APIs via an . public abstract class DelegatingLuaLibraryEmu : DelegatingLuaLibrary { protected DelegatingLuaLibraryEmu(Lua lua) : base(lua) {} diff --git a/src/BizHawk.Common/CustomCollections.cs b/src/BizHawk.Common/CustomCollections.cs index 9a6eae030a..6367488f52 100644 --- a/src/BizHawk.Common/CustomCollections.cs +++ b/src/BizHawk.Common/CustomCollections.cs @@ -7,7 +7,7 @@ using System.Runtime.Serialization; namespace BizHawk.Common { - /// Wrapper over WorkingDictionary<, List<>>. + /// Wrapper over WorkingDictionary<, List<>>. [Serializable] public class Bag : IEnumerable where TKey : notnull { diff --git a/src/BizHawk.Common/HawkFile/HawkArchiveFileItem.cs b/src/BizHawk.Common/HawkFile/HawkArchiveFileItem.cs index 58ad999ca9..325af6eb94 100644 --- a/src/BizHawk.Common/HawkFile/HawkArchiveFileItem.cs +++ b/src/BizHawk.Common/HawkFile/HawkArchiveFileItem.cs @@ -4,7 +4,7 @@ namespace BizHawk.Common public readonly struct HawkArchiveFileItem { /// the index of the member within the archive, not to be confused with - /// this is for implementations to use internally + /// this is for implementations to use internally public readonly int ArchiveIndex; /// the index of this archive item diff --git a/src/BizHawk.Common/HawkFile/HawkFile.cs b/src/BizHawk.Common/HawkFile/HawkFile.cs index ff99b48206..fad3af90b1 100644 --- a/src/BizHawk.Common/HawkFile/HawkFile.cs +++ b/src/BizHawk.Common/HawkFile/HawkFile.cs @@ -16,7 +16,7 @@ namespace BizHawk.Common /// Strings formatted this way are annotated [HawkFilePath]. /// /// - /// This class is defensively designed around to allow swapping out implementations (for speed) without adding any dependencies to this project.
+ /// This class is defensively designed around to allow swapping out implementations (for speed) without adding any dependencies to this project.
/// TODO split into "bind" and "open <the bound thing>"
/// TODO scan archive to flatten interior directories down to a path (maintain our own archive item list) /// diff --git a/src/BizHawk.Common/HawkFile/IHawkArchiveFile.cs b/src/BizHawk.Common/HawkFile/IHawkArchiveFile.cs index c5d2080246..3b2f910c98 100644 --- a/src/BizHawk.Common/HawkFile/IHawkArchiveFile.cs +++ b/src/BizHawk.Common/HawkFile/IHawkArchiveFile.cs @@ -4,7 +4,7 @@ using System.IO; namespace BizHawk.Common { - /// + /// public interface IHawkArchiveFile : IDisposable { void ExtractFile(int index, Stream stream); diff --git a/src/BizHawk.Common/Util.cs b/src/BizHawk.Common/Util.cs index fa648dcf96..10074202a3 100644 --- a/src/BizHawk.Common/Util.cs +++ b/src/BizHawk.Common/Util.cs @@ -38,7 +38,7 @@ namespace BizHawk.Common return data; } - /// adapted from https://stackoverflow.com/a/3928856/7467292, values are compared using EqualityComparer.Default + /// adapted from https://stackoverflow.com/a/3928856/7467292, values are compared using EqualityComparer.Default public static bool DictionaryEqual(IDictionary a, IDictionary b) where TKey : notnull { diff --git a/src/BizHawk.Emulation.Common/Interfaces/IEmulator.cs b/src/BizHawk.Emulation.Common/Interfaces/IEmulator.cs index e984af324b..0f148bfe44 100644 --- a/src/BizHawk.Emulation.Common/Interfaces/IEmulator.cs +++ b/src/BizHawk.Emulation.Common/Interfaces/IEmulator.cs @@ -27,7 +27,7 @@ namespace BizHawk.Emulation.Common /// /// Runs the emulator core for 1 frame /// note that (some?) cores expect you to call SoundProvider.GetSamples() after each FrameAdvance() - /// please do this, even when = false + /// please do this, even when = false /// The instance that the core will use for input. /// The provided by the client must provide the buttons specified by the core through the property /// diff --git a/src/BizHawk.Emulation.Cores/Computers/MSX/LibMSX.cs b/src/BizHawk.Emulation.Cores/Computers/MSX/LibMSX.cs index 80422d205a..ba3facfa4b 100644 --- a/src/BizHawk.Emulation.Cores/Computers/MSX/LibMSX.cs +++ b/src/BizHawk.Emulation.Cores/Computers/MSX/LibMSX.cs @@ -151,7 +151,6 @@ namespace BizHawk.Emulation.Cores.Computers.MSX /// /// opaque state pointer /// pointer to const char * - /// null to clear [DllImport("MSXHawk.dll", CallingConvention = CallingConvention.Cdecl)] public static extern void MSX_getheader(IntPtr core, StringBuilder h, int l); @@ -159,7 +158,7 @@ namespace BizHawk.Emulation.Cores.Computers.MSX /// get the register state from the cpu /// /// opaque state pointer - /// pointer to const char * + /// pointer to const char * /// call type /// copy length, must be obtained from appropriate get legnth function [DllImport("MSXHawk.dll", CallingConvention = CallingConvention.Cdecl)] @@ -169,7 +168,7 @@ namespace BizHawk.Emulation.Cores.Computers.MSX /// get the register state from the cpu /// /// opaque state pointer - /// pointer to const char * + /// pointer to const char * /// call type /// copy length, must be obtained from appropriate get legnth function [DllImport("MSXHawk.dll", CallingConvention = CallingConvention.Cdecl)] diff --git a/src/BizHawk.Emulation.Cores/Consoles/Nintendo/Gameboy/LibGambatte.cs b/src/BizHawk.Emulation.Cores/Consoles/Nintendo/Gameboy/LibGambatte.cs index c331f13eb7..10309f993b 100644 --- a/src/BizHawk.Emulation.Cores/Consoles/Nintendo/Gameboy/LibGambatte.cs +++ b/src/BizHawk.Emulation.Cores/Consoles/Nintendo/Gameboy/LibGambatte.cs @@ -208,7 +208,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.Gameboy /// /// type of the cpu trace callback /// - /// cpu state + /// cpu state [UnmanagedFunctionPointer(CallingConvention.Cdecl)] public delegate void TraceCallback(IntPtr state); diff --git a/src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64.cs b/src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64.cs index 042b5361a6..0fed3286f6 100644 --- a/src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64.cs +++ b/src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64.cs @@ -22,7 +22,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 /// Create mupen64plus Emulator /// /// Game information of game to load - /// Rom that should be loaded + /// Rom that should be loaded /// N64SyncSettings object [CoreConstructor("N64")] public N64(GameInfo game, byte[] file, object settings, object syncSettings) diff --git a/src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64Audio.cs b/src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64Audio.cs index 689974e4ab..6934951db7 100644 --- a/src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64Audio.cs +++ b/src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64Audio.cs @@ -39,7 +39,6 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 /// /// Creates a N64 Audio subsystem /// - /// Mupen64 api which is used for fetching sound public N64Audio(mupen64plusApi core) { this.api = new mupen64plusAudioApi(core); diff --git a/src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64VideoProvider.cs b/src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64VideoProvider.cs index 1623e0f3f8..adcf09fc29 100644 --- a/src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64VideoProvider.cs +++ b/src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64VideoProvider.cs @@ -15,7 +15,6 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64 /// /// Creates N64 Video system with mupen64plus backend /// - /// mupen64plus DLL that is used public N64VideoProvider(mupen64plusApi core, VideoPluginSettings videosettings) { this.api = new mupen64plusVideoApi(core, videosettings); diff --git a/src/BizHawk.Emulation.Cores/Sound/SyncSoundMixer.cs b/src/BizHawk.Emulation.Cores/Sound/SyncSoundMixer.cs index 13e4713d65..e060d6750b 100644 --- a/src/BizHawk.Emulation.Cores/Sound/SyncSoundMixer.cs +++ b/src/BizHawk.Emulation.Cores/Sound/SyncSoundMixer.cs @@ -81,7 +81,6 @@ namespace BizHawk.Emulation.Cores.Components /// /// The source ISoundProvider /// An ident string for the ISoundProvider (useful when debugging) - /// If this is true then only half the samples should be present public void PinSource(ISoundProvider source, string sourceDescription) { PinSource(source, sourceDescription, FinalMaxVolume); @@ -93,7 +92,6 @@ namespace BizHawk.Emulation.Cores.Components /// The source ISoundProvider /// An ident string for the ISoundProvider (useful when debugging) /// The MaxVolume level for this particular ISoundProvider - /// If this is true then only half the samples should be present public void PinSource(ISoundProvider source, string sourceDescription, short sourceMaxVolume) { _soundProviders.Add(new ChildProvider diff --git a/src/BizHawk.Emulation.Cores/Sound/VRC6Alt.cs b/src/BizHawk.Emulation.Cores/Sound/VRC6Alt.cs index 60f7df8d56..ac6c0ca789 100644 --- a/src/BizHawk.Emulation.Cores/Sound/VRC6Alt.cs +++ b/src/BizHawk.Emulation.Cores/Sound/VRC6Alt.cs @@ -14,7 +14,6 @@ namespace BizHawk.Emulation.Cores.Components Action enqueuer; - /// frequency of the M2 clock in hz /// a place to dump deltas to public VRC6Alt(Action enqueuer) { diff --git a/src/BizHawk.Emulation.DiscSystem/Internal/SynthUtils.cs b/src/BizHawk.Emulation.DiscSystem/Internal/SynthUtils.cs index 1f7fe5a0a8..a5d7c00ebd 100644 --- a/src/BizHawk.Emulation.DiscSystem/Internal/SynthUtils.cs +++ b/src/BizHawk.Emulation.DiscSystem/Internal/SynthUtils.cs @@ -5,7 +5,7 @@ namespace BizHawk.Emulation.DiscSystem /// /// Calculates the checksum of the provided Q subchannel buffer and emplaces it /// - /// 12 byte Q subchannel buffer: input and output buffer for operation + /// 12 byte Q subchannel buffer: input and output buffer for operation /// location within buffer of Q subchannel public static ushort SubQ_SynthChecksum(byte[] buf12, int offset) { diff --git a/src/BizHawk.WinForms.Controls/Docs.cs b/src/BizHawk.WinForms.Controls/Docs.cs index e750b84aa1..e160861e6c 100644 --- a/src/BizHawk.WinForms.Controls/Docs.cs +++ b/src/BizHawk.WinForms.Controls/Docs.cs @@ -41,7 +41,7 @@ namespace BizHawk.WinForms.Controls /// /// Inherits . - /// is locked to and is locked to . + /// is locked to and is locked to . /// is locked to / for rows/columns, respectively. /// /// Naming convention for control types @@ -51,7 +51,7 @@ namespace BizHawk.WinForms.Controls /// /// Inherits . - /// is locked to and is locked to . + /// is locked to and is locked to . /// is locked to / for a single row/column, respectively. /// /// Naming convention for control types diff --git a/src/MainSlnCommon.props b/src/MainSlnCommon.props index d644156e98..f54e1b6dea 100644 --- a/src/MainSlnCommon.props +++ b/src/MainSlnCommon.props @@ -5,7 +5,7 @@ $(ProjectDir)../../Common.ruleset $(ProjectDir)bin/doc_comments.xml NU1702 - CS1572;CS1573;CS1574;CS1591;CS1734;NU1701 + CS1573;CS1591;NU1701 $(ProjectDir)../../output/dll