From c93a0f9d1be5406a5571155f181f873aca67ca5a Mon Sep 17 00:00:00 2001 From: YoshiRulz Date: Sun, 7 Jul 2024 12:12:08 +1000 Subject: [PATCH] Enable SA1514 and fix noncompliance (except in Cores) "Element documentation header should be preceded by blank line" --- .global.editorconfig.ini | 2 +- src/BizHawk.BizInvoke/BizInvoker.cs | 2 ++ src/BizHawk.BizInvoke/CallingConventionAdapter.cs | 2 ++ src/BizHawk.Client.Common/Api/BizHawkExternalToolUsage.cs | 2 ++ .../DisplayManager/DisplayManagerBase.cs | 1 + src/BizHawk.Client.Common/movie/import/FmvImport.cs | 1 - src/BizHawk.Client.Common/movie/import/LsmvImport.cs | 1 - src/BizHawk.Client.Common/movie/import/MmvImport.cs | 1 - src/BizHawk.Client.Common/movie/import/SmvImport.cs | 1 - src/BizHawk.Client.Common/movie/interfaces/IMovie.cs | 1 + src/BizHawk.Client.Common/rewind/IRewinder.cs | 1 + src/BizHawk.Client.EmuHawk/AVOut/IVideoWriter.cs | 6 ++++-- src/BizHawk.Client.EmuHawk/AVOut/JMDWriter.cs | 1 + .../CustomControls/ClipboardEventTextBox.cs | 1 + src/BizHawk.Client.EmuHawk/tools/GB/GBGPUView.cs | 1 + .../VirtualPads/controls/components/AnalogStickPanel.cs | 1 + src/BizHawk.Common/Win32/Shell32Imports.cs | 8 ++++++++ .../BizHawk.Emulation.Cores.csproj | 2 +- 18 files changed, 27 insertions(+), 8 deletions(-) diff --git a/.global.editorconfig.ini b/.global.editorconfig.ini index 80e4550a03..70e07c2666 100644 --- a/.global.editorconfig.ini +++ b/.global.editorconfig.ini @@ -552,7 +552,7 @@ dotnet_diagnostic.SA1512.severity = silent # Closing brace should be followed by blank line dotnet_diagnostic.SA1513.severity = silent # Element documentation header should be preceded by blank line -dotnet_diagnostic.SA1514.severity = silent +dotnet_diagnostic.SA1514.severity = warn # Single-line comment should be preceded by blank line dotnet_diagnostic.SA1515.severity = silent # Elements should be separated by blank line diff --git a/src/BizHawk.BizInvoke/BizInvoker.cs b/src/BizHawk.BizInvoke/BizInvoker.cs index 2d3bff2afa..a1bc4a4d9e 100644 --- a/src/BizHawk.BizInvoke/BizInvoker.cs +++ b/src/BizHawk.BizInvoke/BizInvoker.cs @@ -83,10 +83,12 @@ namespace BizHawk.BizInvoke /// How far into a class pointer the first field is. Different on mono and fw. /// private static readonly int ClassFieldOffset; + /// /// How far into a string pointer the first chair is. /// private static readonly int StringOffset; + /// /// How far into a value array type element 0 is. /// diff --git a/src/BizHawk.BizInvoke/CallingConventionAdapter.cs b/src/BizHawk.BizInvoke/CallingConventionAdapter.cs index afae616781..435efd59fc 100644 --- a/src/BizHawk.BizInvoke/CallingConventionAdapter.cs +++ b/src/BizHawk.BizInvoke/CallingConventionAdapter.cs @@ -35,6 +35,7 @@ namespace BizHawk.BizInvoke /// /// Delegate GetDelegateForFunctionPointer(IntPtr p, Type delegateType); + /// /// Like Marshal.GetDelegateForFunctionPointer(), but only the unmanaged thunk-to-thunk part, with no /// managed wrapper involved.static Called "departure" beause it is to be used when first leaving host @@ -90,6 +91,7 @@ namespace BizHawk.BizInvoke /// any meaning to CallingConvention Adapter; it's just a unique key associated with the callback. /// IntPtr GetCallbackProcAddr(IntPtr exitPoint, int slot); + /// /// Returns a thunk over a departure point. /// diff --git a/src/BizHawk.Client.Common/Api/BizHawkExternalToolUsage.cs b/src/BizHawk.Client.Common/Api/BizHawkExternalToolUsage.cs index 937a96a91f..719ad47464 100644 --- a/src/BizHawk.Client.Common/Api/BizHawkExternalToolUsage.cs +++ b/src/BizHawk.Client.Common/Api/BizHawkExternalToolUsage.cs @@ -9,10 +9,12 @@ /// General usage, works even with null emulator /// Global = 0, + /// /// Specific to an emulator (NES,SNES,etc...) /// EmulatorSpecific = 1, + /// /// Specific to a Game /// diff --git a/src/BizHawk.Client.Common/DisplayManager/DisplayManagerBase.cs b/src/BizHawk.Client.Common/DisplayManager/DisplayManagerBase.cs index 08bd2a8ff9..91945c8c77 100644 --- a/src/BizHawk.Client.Common/DisplayManager/DisplayManagerBase.cs +++ b/src/BizHawk.Client.Common/DisplayManager/DisplayManagerBase.cs @@ -490,6 +490,7 @@ namespace BizHawk.Client.Common UpdateSourceInternal(job); return job.OffscreenBb; } + /// /// Does the display process to an offscreen buffer, suitable for a Lua-inclusive movie. /// diff --git a/src/BizHawk.Client.Common/movie/import/FmvImport.cs b/src/BizHawk.Client.Common/movie/import/FmvImport.cs index 1b86bf00d2..ed23ef5d13 100644 --- a/src/BizHawk.Client.Common/movie/import/FmvImport.cs +++ b/src/BizHawk.Client.Common/movie/import/FmvImport.cs @@ -5,7 +5,6 @@ using BizHawk.Emulation.Cores.Nintendo.NES; namespace BizHawk.Client.Common.movie.import { - // ReSharper disable once UnusedMember.Global /// For Famtasia's .fmv format [ImporterFor("Famtasia", ".fmv")] internal class FmvImport : MovieImporter diff --git a/src/BizHawk.Client.Common/movie/import/LsmvImport.cs b/src/BizHawk.Client.Common/movie/import/LsmvImport.cs index 6254cb4af7..95352984d6 100644 --- a/src/BizHawk.Client.Common/movie/import/LsmvImport.cs +++ b/src/BizHawk.Client.Common/movie/import/LsmvImport.cs @@ -12,7 +12,6 @@ using BizHawk.Emulation.Cores.Nintendo.BSNES; namespace BizHawk.Client.Common.movie.import { - // ReSharper disable once UnusedMember.Global /// For lsnes' .lsmv format [ImporterFor("LSNES", ".lsmv")] internal class LsmvImport : MovieImporter diff --git a/src/BizHawk.Client.Common/movie/import/MmvImport.cs b/src/BizHawk.Client.Common/movie/import/MmvImport.cs index 7e05ebb698..0185d78abf 100644 --- a/src/BizHawk.Client.Common/movie/import/MmvImport.cs +++ b/src/BizHawk.Client.Common/movie/import/MmvImport.cs @@ -5,7 +5,6 @@ using BizHawk.Emulation.Cores.Sega.MasterSystem; namespace BizHawk.Client.Common.movie.import { - // ReSharper disable once UnusedMember.Global /// For Dega's .mmv format [ImporterFor("Dega", ".mmv")] internal class MmvImport : MovieImporter diff --git a/src/BizHawk.Client.Common/movie/import/SmvImport.cs b/src/BizHawk.Client.Common/movie/import/SmvImport.cs index 1de6bf9be5..9a050b92f0 100644 --- a/src/BizHawk.Client.Common/movie/import/SmvImport.cs +++ b/src/BizHawk.Client.Common/movie/import/SmvImport.cs @@ -8,7 +8,6 @@ using BizHawk.Emulation.Cores.Nintendo.SNES9X; namespace BizHawk.Client.Common.movie.import { - // ReSharper disable once UnusedMember.Global /// For Snes9x's .smv format [ImporterFor("Snes9x", ".smv")] internal class SmvImport : MovieImporter diff --git a/src/BizHawk.Client.Common/movie/interfaces/IMovie.cs b/src/BizHawk.Client.Common/movie/interfaces/IMovie.cs index 1f7d05388f..045d183ecf 100644 --- a/src/BizHawk.Client.Common/movie/interfaces/IMovie.cs +++ b/src/BizHawk.Client.Common/movie/interfaces/IMovie.cs @@ -215,6 +215,7 @@ namespace BizHawk.Client.Common public static bool IsFinished(this IMovie movie) => movie?.Mode == MovieMode.Finished; public static bool IsPlayingOrFinished(this IMovie movie) => movie?.Mode == MovieMode.Play || movie?.Mode == MovieMode.Finished; public static bool IsPlayingOrRecording(this IMovie movie) => movie?.Mode == MovieMode.Play || movie?.Mode == MovieMode.Record; + /// /// Emulation is currently right after the movie's last input frame, /// but no further frames have been emulated. diff --git a/src/BizHawk.Client.Common/rewind/IRewinder.cs b/src/BizHawk.Client.Common/rewind/IRewinder.cs index 1714dc1858..25df1fb802 100644 --- a/src/BizHawk.Client.Common/rewind/IRewinder.cs +++ b/src/BizHawk.Client.Common/rewind/IRewinder.cs @@ -10,6 +10,7 @@ namespace BizHawk.Client.Common bool Active { get; } void Capture(int frame); + /// /// Rewind 1 or 2 saved frames, avoiding frameToAvoid if possible. /// diff --git a/src/BizHawk.Client.EmuHawk/AVOut/IVideoWriter.cs b/src/BizHawk.Client.EmuHawk/AVOut/IVideoWriter.cs index bd0b8ac11f..743649930e 100644 --- a/src/BizHawk.Client.EmuHawk/AVOut/IVideoWriter.cs +++ b/src/BizHawk.Client.EmuHawk/AVOut/IVideoWriter.cs @@ -28,12 +28,14 @@ namespace BizHawk.Client.EmuHawk /// bool UsesVideo { get; } - // why no OpenFile(IEnumerator) ? - // different video writers may have different ideas of how and why splitting is to occur /// /// opens a recording stream /// set a video codec token first. /// + /// + /// why no OpenFile(IEnumerator<string>)? + /// different video writers may have different ideas of how and why splitting is to occur + /// void OpenFile(string baseName); /// diff --git a/src/BizHawk.Client.EmuHawk/AVOut/JMDWriter.cs b/src/BizHawk.Client.EmuHawk/AVOut/JMDWriter.cs index 248c02c92e..8d0800ebf1 100644 --- a/src/BizHawk.Client.EmuHawk/AVOut/JMDWriter.cs +++ b/src/BizHawk.Client.EmuHawk/AVOut/JMDWriter.cs @@ -623,6 +623,7 @@ namespace BizHawk.Client.EmuHawk } // some of this code is copied from AviWriter... not sure how if at all it should be abstracted + /// /// blocking thread safe queue, used for communication between main program and file writing thread /// diff --git a/src/BizHawk.Client.EmuHawk/CustomControls/ClipboardEventTextBox.cs b/src/BizHawk.Client.EmuHawk/CustomControls/ClipboardEventTextBox.cs index d48b302cad..a2ff671c34 100644 --- a/src/BizHawk.Client.EmuHawk/CustomControls/ClipboardEventTextBox.cs +++ b/src/BizHawk.Client.EmuHawk/CustomControls/ClipboardEventTextBox.cs @@ -80,6 +80,7 @@ namespace BizHawk.Client.EmuHawk.CustomControls { public bool ContainsText { get; } public string Text { get; } + /// Prevents regular paste handling if set to . public bool Handled { get; set; } diff --git a/src/BizHawk.Client.EmuHawk/tools/GB/GBGPUView.cs b/src/BizHawk.Client.EmuHawk/tools/GB/GBGPUView.cs index 9db1e86a66..048aa51207 100644 --- a/src/BizHawk.Client.EmuHawk/tools/GB/GBGPUView.cs +++ b/src/BizHawk.Client.EmuHawk/tools/GB/GBGPUView.cs @@ -43,6 +43,7 @@ namespace BizHawk.Client.EmuHawk /// Whether the tiles are being drawn with the sprite or bg palettes /// private bool _tilesPalIsSprite; + /// /// How far (in bytes, I guess?) we should offset into the tiles palette /// diff --git a/src/BizHawk.Client.EmuHawk/tools/VirtualPads/controls/components/AnalogStickPanel.cs b/src/BizHawk.Client.EmuHawk/tools/VirtualPads/controls/components/AnalogStickPanel.cs index 21a2f68444..84f26da6ac 100644 --- a/src/BizHawk.Client.EmuHawk/tools/VirtualPads/controls/components/AnalogStickPanel.cs +++ b/src/BizHawk.Client.EmuHawk/tools/VirtualPads/controls/components/AnalogStickPanel.cs @@ -107,6 +107,7 @@ namespace BizHawk.Client.EmuHawk /// min + (max - i) == max - (i - min) == min + max - i /// private int MaybeReversedInX(int i) => _reverseX ? _rangeX.Start + _rangeX.EndInclusive - i : i; + /// private int MaybeReversedInY(int i) => _reverseY ? i : _rangeY.Start + _rangeY.EndInclusive - i; diff --git a/src/BizHawk.Common/Win32/Shell32Imports.cs b/src/BizHawk.Common/Win32/Shell32Imports.cs index 4f1ca3ee31..fcf32f06de 100644 --- a/src/BizHawk.Common/Win32/Shell32Imports.cs +++ b/src/BizHawk.Common/Win32/Shell32Imports.cs @@ -34,20 +34,28 @@ namespace BizHawk.Common { /// BIF_RETURNONLYFSDIRS RestrictToFilesystem = 0x0001, + /// BIF_DONTGOBELOWDOMAIN RestrictToDomain = 0x0002, + /// BIF_RETURNFSANCESTORS RestrictToSubfolders = 0x0008, + /// BIF_EDITBOX ShowTextBox = 0x0010, + /// BIF_VALIDATE ValidateSelection = 0x0020, + /// BIF_NEWDIALOGSTYLE NewDialogStyle = 0x0040, + /// BIF_BROWSEFORCOMPUTER BrowseForComputer = 0x1000, + /// BIF_BROWSEFORPRINTER BrowseForPrinter = 0x2000, + /// BIF_BROWSEINCLUDEFILES BrowseForEverything = 0x4000 } diff --git a/src/BizHawk.Emulation.Cores/BizHawk.Emulation.Cores.csproj b/src/BizHawk.Emulation.Cores/BizHawk.Emulation.Cores.csproj index 67a8196844..4d80ac353f 100644 --- a/src/BizHawk.Emulation.Cores/BizHawk.Emulation.Cores.csproj +++ b/src/BizHawk.Emulation.Cores/BizHawk.Emulation.Cores.csproj @@ -5,7 +5,7 @@ true - $(NoWarn);CA1806;CA1825;CA2214;MA0060;MA0084;MA0090;MA0140;SA1100;SA1120;SA1129;SA1137;SA1205;SA1208;SA1400 + $(NoWarn);CA1806;CA1825;CA2214;MA0060;MA0084;MA0090;MA0140;SA1100;SA1120;SA1129;SA1137;SA1205;SA1208;SA1400;SA1514 disable