Enable RCS1226, except in Cores, and mute 2 other existing violations

"Add paragraph to documentation comment" (line break without markup
results in collapsed space, like in HTML)
This commit is contained in:
YoshiRulz 2025-06-22 19:53:28 +10:00
parent 5d76b92a41
commit 7df0cef0db
No known key found for this signature in database
GPG Key ID: C4DE31C245353FB7
4 changed files with 7 additions and 1 deletions

View File

@ -460,6 +460,8 @@ dotnet_diagnostic.RCS1194.severity = silent
dotnet_diagnostic.RCS1195.severity = warning dotnet_diagnostic.RCS1195.severity = warning
# Make method an extension method # Make method an extension method
dotnet_diagnostic.RCS1224.severity = warning dotnet_diagnostic.RCS1224.severity = warning
# Add paragraph to documentation comment
dotnet_diagnostic.RCS1226.severity = warning
# Do not pass non-read-only struct by read-only reference # Do not pass non-read-only struct by read-only reference
dotnet_diagnostic.RCS1242.severity = silent dotnet_diagnostic.RCS1242.severity = silent

View File

@ -5,7 +5,7 @@
<Import Project="../MainSlnCommon.props" /> <Import Project="../MainSlnCommon.props" />
<PropertyGroup> <PropertyGroup>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks> <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<NoWarn>$(NoWarn);BHI1104;CA1806;CA1825;CA2214;MA0060;MA0084;MA0090;MA0140;MEN018;RCS1215;RS0030;SA1100;SA1120;SA1129;SA1137;SA1205;SA1208;SA1400;SA1413;SA1514;SA1517</NoWarn> <NoWarn>$(NoWarn);BHI1104;CA1806;CA1825;CA2214;MA0060;MA0084;MA0090;MA0140;MEN018;RCS1215;RCS1226;RS0030;SA1100;SA1120;SA1129;SA1137;SA1205;SA1208;SA1400;SA1413;SA1514;SA1517</NoWarn>
<Nullable>disable</Nullable> <Nullable>disable</Nullable>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>

View File

@ -33,6 +33,7 @@ namespace BizHawk.Emulation.DiscSystem
DiscStreamView_Mode2_Form2_2324, DiscStreamView_Mode2_Form2_2324,
} }
#pragma warning disable RCS1226 // bad formatting
/// <summary> /// <summary>
/// Allows you to stream data off a disc. /// Allows you to stream data off a disc.
/// For future work: depending on the View you select, it may not be seekable (in other words, it would need to read sequentially) /// For future work: depending on the View you select, it may not be seekable (in other words, it would need to read sequentially)
@ -48,6 +49,7 @@ namespace BizHawk.Emulation.DiscSystem
/// TODO - Receive some information about the track that this stream is modeling, and have the stream return EOF at the end of the track? /// TODO - Receive some information about the track that this stream is modeling, and have the stream return EOF at the end of the track?
/// </summary> /// </summary>
public class DiscStream : System.IO.Stream public class DiscStream : System.IO.Stream
#pragma warning restore RCS1226
{ {
private readonly int SectorSize; private readonly int SectorSize;
private readonly int NumSectors; private readonly int NumSectors;

View File

@ -7,6 +7,7 @@ using BizHawk.Common.PathExtensions;
namespace BizHawk.Emulation.DiscSystem namespace BizHawk.Emulation.DiscSystem
{ {
#pragma warning disable RCS1226 // bad formatting
/// <remarks> /// <remarks>
/// cue format preferences notes /// cue format preferences notes
/// ///
@ -16,6 +17,7 @@ namespace BizHawk.Emulation.DiscSystem
/// it seems not to be able to handle binpertrack, or maybe i am doing something wrong (still haven't ruled it out) /// it seems not to be able to handle binpertrack, or maybe i am doing something wrong (still haven't ruled it out)
/// </remarks> /// </remarks>
public static class DiscoHawkLogic public static class DiscoHawkLogic
#pragma warning restore RCS1226
{ {
private static bool CompareFile(string infile, DiscInterface loadDiscInterface, DiscInterface cmpif, bool verbose, CancellationTokenSource cancelToken, StringWriter sw) private static bool CompareFile(string infile, DiscInterface loadDiscInterface, DiscInterface cmpif, bool verbose, CancellationTokenSource cancelToken, StringWriter sw)
{ {