Enable SA1514 and fix noncompliance (except in Cores)
"Element documentation header should be preceded by blank line"
This commit is contained in:
parent
ee9639a6fc
commit
c93a0f9d1b
|
@ -552,7 +552,7 @@ dotnet_diagnostic.SA1512.severity = silent
|
||||||
# Closing brace should be followed by blank line
|
# Closing brace should be followed by blank line
|
||||||
dotnet_diagnostic.SA1513.severity = silent
|
dotnet_diagnostic.SA1513.severity = silent
|
||||||
# Element documentation header should be preceded by blank line
|
# 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
|
# Single-line comment should be preceded by blank line
|
||||||
dotnet_diagnostic.SA1515.severity = silent
|
dotnet_diagnostic.SA1515.severity = silent
|
||||||
# Elements should be separated by blank line
|
# Elements should be separated by blank line
|
||||||
|
|
|
@ -83,10 +83,12 @@ namespace BizHawk.BizInvoke
|
||||||
/// How far into a class pointer the first field is. Different on mono and fw.
|
/// How far into a class pointer the first field is. Different on mono and fw.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
private static readonly int ClassFieldOffset;
|
private static readonly int ClassFieldOffset;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// How far into a string pointer the first chair is.
|
/// How far into a string pointer the first chair is.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
private static readonly int StringOffset;
|
private static readonly int StringOffset;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// How far into a value array type element 0 is.
|
/// How far into a value array type element 0 is.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|
|
@ -35,6 +35,7 @@ namespace BizHawk.BizInvoke
|
||||||
/// <param name="delegateType"></param>
|
/// <param name="delegateType"></param>
|
||||||
/// <returns></returns>
|
/// <returns></returns>
|
||||||
Delegate GetDelegateForFunctionPointer(IntPtr p, Type delegateType);
|
Delegate GetDelegateForFunctionPointer(IntPtr p, Type delegateType);
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Like Marshal.GetDelegateForFunctionPointer(), but only the unmanaged thunk-to-thunk part, with no
|
/// 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
|
/// 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.
|
/// any meaning to CallingConvention Adapter; it's just a unique key associated with the callback.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
IntPtr GetCallbackProcAddr(IntPtr exitPoint, int slot);
|
IntPtr GetCallbackProcAddr(IntPtr exitPoint, int slot);
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Returns a thunk over a departure point.
|
/// Returns a thunk over a departure point.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|
|
@ -9,10 +9,12 @@
|
||||||
/// General usage, works even with null emulator
|
/// General usage, works even with null emulator
|
||||||
/// </summary>
|
/// </summary>
|
||||||
Global = 0,
|
Global = 0,
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Specific to an emulator (NES,SNES,etc...)
|
/// Specific to an emulator (NES,SNES,etc...)
|
||||||
/// </summary>
|
/// </summary>
|
||||||
EmulatorSpecific = 1,
|
EmulatorSpecific = 1,
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Specific to a Game
|
/// Specific to a Game
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|
|
@ -490,6 +490,7 @@ namespace BizHawk.Client.Common
|
||||||
UpdateSourceInternal(job);
|
UpdateSourceInternal(job);
|
||||||
return job.OffscreenBb;
|
return job.OffscreenBb;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Does the display process to an offscreen buffer, suitable for a Lua-inclusive movie.
|
/// Does the display process to an offscreen buffer, suitable for a Lua-inclusive movie.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|
|
@ -5,7 +5,6 @@ using BizHawk.Emulation.Cores.Nintendo.NES;
|
||||||
|
|
||||||
namespace BizHawk.Client.Common.movie.import
|
namespace BizHawk.Client.Common.movie.import
|
||||||
{
|
{
|
||||||
// ReSharper disable once UnusedMember.Global
|
|
||||||
/// <summary>For Famtasia's <see href="https://tasvideos.org/EmulatorResources/Famtasia/FMV"><c>.fmv</c> format</see></summary>
|
/// <summary>For Famtasia's <see href="https://tasvideos.org/EmulatorResources/Famtasia/FMV"><c>.fmv</c> format</see></summary>
|
||||||
[ImporterFor("Famtasia", ".fmv")]
|
[ImporterFor("Famtasia", ".fmv")]
|
||||||
internal class FmvImport : MovieImporter
|
internal class FmvImport : MovieImporter
|
||||||
|
|
|
@ -12,7 +12,6 @@ using BizHawk.Emulation.Cores.Nintendo.BSNES;
|
||||||
|
|
||||||
namespace BizHawk.Client.Common.movie.import
|
namespace BizHawk.Client.Common.movie.import
|
||||||
{
|
{
|
||||||
// ReSharper disable once UnusedMember.Global
|
|
||||||
/// <summary>For lsnes' <see href="https://tasvideos.org/Lsnes/Movieformat"><c>.lsmv</c> format</see></summary>
|
/// <summary>For lsnes' <see href="https://tasvideos.org/Lsnes/Movieformat"><c>.lsmv</c> format</see></summary>
|
||||||
[ImporterFor("LSNES", ".lsmv")]
|
[ImporterFor("LSNES", ".lsmv")]
|
||||||
internal class LsmvImport : MovieImporter
|
internal class LsmvImport : MovieImporter
|
||||||
|
|
|
@ -5,7 +5,6 @@ using BizHawk.Emulation.Cores.Sega.MasterSystem;
|
||||||
|
|
||||||
namespace BizHawk.Client.Common.movie.import
|
namespace BizHawk.Client.Common.movie.import
|
||||||
{
|
{
|
||||||
// ReSharper disable once UnusedMember.Global
|
|
||||||
/// <summary>For Dega's <see href="https://tasvideos.org/EmulatorResources/MMV"><c>.mmv</c> format</see></summary>
|
/// <summary>For Dega's <see href="https://tasvideos.org/EmulatorResources/MMV"><c>.mmv</c> format</see></summary>
|
||||||
[ImporterFor("Dega", ".mmv")]
|
[ImporterFor("Dega", ".mmv")]
|
||||||
internal class MmvImport : MovieImporter
|
internal class MmvImport : MovieImporter
|
||||||
|
|
|
@ -8,7 +8,6 @@ using BizHawk.Emulation.Cores.Nintendo.SNES9X;
|
||||||
|
|
||||||
namespace BizHawk.Client.Common.movie.import
|
namespace BizHawk.Client.Common.movie.import
|
||||||
{
|
{
|
||||||
// ReSharper disable once UnusedMember.Global
|
|
||||||
/// <summary>For Snes9x's <see href="https://tasvideos.org/EmulatorResources/Snes9x/SMV"><c>.smv</c> format</see></summary>
|
/// <summary>For Snes9x's <see href="https://tasvideos.org/EmulatorResources/Snes9x/SMV"><c>.smv</c> format</see></summary>
|
||||||
[ImporterFor("Snes9x", ".smv")]
|
[ImporterFor("Snes9x", ".smv")]
|
||||||
internal class SmvImport : MovieImporter
|
internal class SmvImport : MovieImporter
|
||||||
|
|
|
@ -215,6 +215,7 @@ namespace BizHawk.Client.Common
|
||||||
public static bool IsFinished(this IMovie movie) => movie?.Mode == MovieMode.Finished;
|
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 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;
|
public static bool IsPlayingOrRecording(this IMovie movie) => movie?.Mode == MovieMode.Play || movie?.Mode == MovieMode.Record;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Emulation is currently right after the movie's last input frame,
|
/// Emulation is currently right after the movie's last input frame,
|
||||||
/// but no further frames have been emulated.
|
/// but no further frames have been emulated.
|
||||||
|
|
|
@ -10,6 +10,7 @@ namespace BizHawk.Client.Common
|
||||||
bool Active { get; }
|
bool Active { get; }
|
||||||
|
|
||||||
void Capture(int frame);
|
void Capture(int frame);
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Rewind 1 or 2 saved frames, avoiding frameToAvoid if possible.
|
/// Rewind 1 or 2 saved frames, avoiding frameToAvoid if possible.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|
|
@ -28,12 +28,14 @@ namespace BizHawk.Client.EmuHawk
|
||||||
/// </summary>
|
/// </summary>
|
||||||
bool UsesVideo { get; }
|
bool UsesVideo { get; }
|
||||||
|
|
||||||
// why no OpenFile(IEnumerator<string>) ?
|
|
||||||
// different video writers may have different ideas of how and why splitting is to occur
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// opens a recording stream
|
/// opens a recording stream
|
||||||
/// set a video codec token first.
|
/// set a video codec token first.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
/// <remarks>
|
||||||
|
/// why no <c>OpenFile(IEnumerator<string>)</c>?
|
||||||
|
/// different video writers may have different ideas of how and why splitting is to occur
|
||||||
|
/// </remarks>
|
||||||
void OpenFile(string baseName);
|
void OpenFile(string baseName);
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
|
|
|
@ -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
|
// some of this code is copied from AviWriter... not sure how if at all it should be abstracted
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// blocking thread safe queue, used for communication between main program and file writing thread
|
/// blocking thread safe queue, used for communication between main program and file writing thread
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|
|
@ -80,6 +80,7 @@ namespace BizHawk.Client.EmuHawk.CustomControls
|
||||||
{
|
{
|
||||||
public bool ContainsText { get; }
|
public bool ContainsText { get; }
|
||||||
public string Text { get; }
|
public string Text { get; }
|
||||||
|
|
||||||
/// <summary>Prevents regular paste handling if set to <see langword="true"/>.</summary>
|
/// <summary>Prevents regular paste handling if set to <see langword="true"/>.</summary>
|
||||||
public bool Handled { get; set; }
|
public bool Handled { get; set; }
|
||||||
|
|
||||||
|
|
|
@ -43,6 +43,7 @@ namespace BizHawk.Client.EmuHawk
|
||||||
/// Whether the tiles are being drawn with the sprite or bg palettes
|
/// Whether the tiles are being drawn with the sprite or bg palettes
|
||||||
/// </summary>
|
/// </summary>
|
||||||
private bool _tilesPalIsSprite;
|
private bool _tilesPalIsSprite;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// How far (in bytes, I guess?) we should offset into the tiles palette
|
/// How far (in bytes, I guess?) we should offset into the tiles palette
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|
|
@ -107,6 +107,7 @@ namespace BizHawk.Client.EmuHawk
|
||||||
/// min + (max - i) == max - (i - min) == min + max - i
|
/// min + (max - i) == max - (i - min) == min + max - i
|
||||||
/// </remarks>
|
/// </remarks>
|
||||||
private int MaybeReversedInX(int i) => _reverseX ? _rangeX.Start + _rangeX.EndInclusive - i : i;
|
private int MaybeReversedInX(int i) => _reverseX ? _rangeX.Start + _rangeX.EndInclusive - i : i;
|
||||||
|
|
||||||
/// <inheritdoc cref="MaybeReversedInX"/>
|
/// <inheritdoc cref="MaybeReversedInX"/>
|
||||||
private int MaybeReversedInY(int i) => _reverseY ? i : _rangeY.Start + _rangeY.EndInclusive - i;
|
private int MaybeReversedInY(int i) => _reverseY ? i : _rangeY.Start + _rangeY.EndInclusive - i;
|
||||||
|
|
||||||
|
|
|
@ -34,20 +34,28 @@ namespace BizHawk.Common
|
||||||
{
|
{
|
||||||
/// <remarks>BIF_RETURNONLYFSDIRS</remarks>
|
/// <remarks>BIF_RETURNONLYFSDIRS</remarks>
|
||||||
RestrictToFilesystem = 0x0001,
|
RestrictToFilesystem = 0x0001,
|
||||||
|
|
||||||
/// <remarks>BIF_DONTGOBELOWDOMAIN</remarks>
|
/// <remarks>BIF_DONTGOBELOWDOMAIN</remarks>
|
||||||
RestrictToDomain = 0x0002,
|
RestrictToDomain = 0x0002,
|
||||||
|
|
||||||
/// <remarks>BIF_RETURNFSANCESTORS</remarks>
|
/// <remarks>BIF_RETURNFSANCESTORS</remarks>
|
||||||
RestrictToSubfolders = 0x0008,
|
RestrictToSubfolders = 0x0008,
|
||||||
|
|
||||||
/// <remarks>BIF_EDITBOX</remarks>
|
/// <remarks>BIF_EDITBOX</remarks>
|
||||||
ShowTextBox = 0x0010,
|
ShowTextBox = 0x0010,
|
||||||
|
|
||||||
/// <remarks>BIF_VALIDATE</remarks>
|
/// <remarks>BIF_VALIDATE</remarks>
|
||||||
ValidateSelection = 0x0020,
|
ValidateSelection = 0x0020,
|
||||||
|
|
||||||
/// <remarks>BIF_NEWDIALOGSTYLE</remarks>
|
/// <remarks>BIF_NEWDIALOGSTYLE</remarks>
|
||||||
NewDialogStyle = 0x0040,
|
NewDialogStyle = 0x0040,
|
||||||
|
|
||||||
/// <remarks>BIF_BROWSEFORCOMPUTER</remarks>
|
/// <remarks>BIF_BROWSEFORCOMPUTER</remarks>
|
||||||
BrowseForComputer = 0x1000,
|
BrowseForComputer = 0x1000,
|
||||||
|
|
||||||
/// <remarks>BIF_BROWSEFORPRINTER</remarks>
|
/// <remarks>BIF_BROWSEFORPRINTER</remarks>
|
||||||
BrowseForPrinter = 0x2000,
|
BrowseForPrinter = 0x2000,
|
||||||
|
|
||||||
/// <remarks>BIF_BROWSEINCLUDEFILES</remarks>
|
/// <remarks>BIF_BROWSEINCLUDEFILES</remarks>
|
||||||
BrowseForEverything = 0x4000
|
BrowseForEverything = 0x4000
|
||||||
}
|
}
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
<Import Project="../MainSlnCommon.props" />
|
<Import Project="../MainSlnCommon.props" />
|
||||||
<PropertyGroup>
|
<PropertyGroup>
|
||||||
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
|
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
|
||||||
<NoWarn>$(NoWarn);CA1806;CA1825;CA2214;MA0060;MA0084;MA0090;MA0140;SA1100;SA1120;SA1129;SA1137;SA1205;SA1208;SA1400</NoWarn>
|
<NoWarn>$(NoWarn);CA1806;CA1825;CA2214;MA0060;MA0084;MA0090;MA0140;SA1100;SA1120;SA1129;SA1137;SA1205;SA1208;SA1400;SA1514</NoWarn>
|
||||||
<Nullable>disable</Nullable>
|
<Nullable>disable</Nullable>
|
||||||
</PropertyGroup>
|
</PropertyGroup>
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
|
|
Loading…
Reference in New Issue