Enable CS1572, CS1574, and CS1734, and fix noncompliance

malformed references or wrong XML tag

src/BizHawk.Client.Common/SharpCompressDearchivalMethod.cs

@@ -11,7 +11,7 @@ using SharpCompress.Common;
 
 namespace BizHawk.Client.Common
 {
-	/// <summary>A <see cref="IFileDearchivalMethod">dearchival method</see> for <see cref="HawkFile"/> implemented using <c>SharpCompress</c> from NuGet.</summary>
+	/// <summary>A <see cref="IFileDearchivalMethod{T}">dearchival method</see> for <see cref="HawkFile"/> implemented using <c>SharpCompress</c> from NuGet.</summary>
 	public class SharpCompressDearchivalMethod : IFileDearchivalMethod<SharpCompressArchiveFile>
 	{
 		private SharpCompressDearchivalMethod() {}

src/BizHawk.Client.Common/config/ToolDialogSettings.cs

@@ -56,7 +56,7 @@ namespace BizHawk.Client.Common
 			}
 		}
 
-		/// <value>the top-left corner of the <see cref="EmuHawk.IToolFormAutoConfig"/>, equivalent to the combined values of <see cref="Wndx"/> and <see cref="Wndy"/></value>
+		/// <value>the top-left corner of the <see cref="IToolFormAutoConfig"/>, equivalent to the combined values of <see cref="Wndx"/> and <see cref="Wndy"/></value>
 		/// <exception cref="InvalidOperationException">either <see cref="Wndx"/> or <see cref="Wndy"/> is null (it is expected to check for this before using this property)</exception>
 		[JsonIgnore]
 		public Point TopLeft

src/BizHawk.Client.Common/inputAdapters/InputManager.cs

@@ -31,7 +31,7 @@ namespace BizHawk.Client.Common
 		public StickyXorAdapter StickyXorAdapter { get; } = new StickyXorAdapter();
 
 		/// <summary>
-		/// Used to AND to another controller, used for <see cref="JoypadApi.Set(Dictionary{string, bool}, int?)">JoypadApi.Set</see>
+		/// Used to AND to another controller, used for <see cref="IJoypadApi.Set(Dictionary{string, bool}, int?)">JoypadApi.Set</see>
 		/// </summary>
 		public OverrideAdapter ButtonOverrideAdapter { get; } = new OverrideAdapter();
 

src/BizHawk.Client.Common/movie/interfaces/IMovie.cs

@@ -284,7 +284,7 @@ namespace BizHawk.Client.Common
 		}
 
 		/// <summary>
-		/// Sets the given <see cref="emulator"/> save ram if the movie contains save ram
+		/// Sets the given <paramref name="emulator"/> save ram if the movie contains save ram
 		/// and the core supports save ram
 		/// </summary>
 		public static void ProcessSram(this IMovie movie, IEmulator emulator)

src/BizHawk.Client.EmuHawk/AVOut/AVSync.cs

@@ -17,7 +17,7 @@ namespace BizHawk.Client.EmuHawk
 
 		/// <exception cref="InvalidOperationException">
 		/// <paramref name="asyncSoundProvider"/>'s mode is not <see cref="SyncSoundMode.Async"/>, or
-		/// A/V parameters haven't been set (need to call <see cref="SetAudioParameters"/> and <see cref="SetMovieParameters"/>)
+		/// A/V parameters haven't been set (need to call <see cref="AVStretcher.SetAudioParameters"/> and <see cref="AVStretcher.SetMovieParameters"/>)
 		/// </exception>
 		public void DumpAV(IVideoProvider v, ISoundProvider asyncSoundProvider, out short[] samples, out int samplesProvided)
 		{

src/BizHawk.Client.EmuHawk/AVOut/NutMuxer.cs

@@ -541,7 +541,7 @@ namespace BizHawk.Client.EmuHawk
 		}
 
 		/// <summary>write a video frame to the stream</summary>
-		/// <param name="data">raw video data; if length 0, write EOR</param>
+		/// <param name="video">raw video data; if length 0, write EOR</param>
 		/// <exception cref="Exception">internal error, possible A/V desync</exception>
 		/// <exception cref="InvalidOperationException">already written EOR</exception>
 		public void WriteVideoFrame(int[] video)
@@ -569,7 +569,7 @@ namespace BizHawk.Client.EmuHawk
 		}
 
 		/// <summary>write an audio frame to the stream</summary>
-		/// <param name="data">raw audio data; if length 0, write EOR</param>
+		/// <param name="samples">raw audio data; if length 0, write EOR</param>
 		/// <exception cref="Exception">internal error, possible A/V desync</exception>
 		/// <exception cref="InvalidOperationException">already written EOR</exception>
 		public void WriteAudioFrame(short[] samples)

src/BizHawk.Client.EmuHawk/GraphicsImplementations/IGL_SlimDX9.cs

@@ -325,7 +325,7 @@ namespace BizHawk.Client.EmuHawk
 
 		/// <exception cref="InvalidOperationException">
 		/// <paramref name="required"/> is <see langword="true"/> and either <paramref name="vertexShader"/> or <paramref name="fragmentShader"/> is unavailable (their <see cref="Shader.Available"/> property is <see langword="false"/>), or
-		/// one of <paramref name="vertexLayout"/>'s items has an unsupported value in <see cref="LayoutItem.AttribType"/>, <see cref="LayoutItem.Components"/>, or <see cref="LayoutItem.Usage"/>
+		/// one of <paramref name="vertexLayout"/>'s items has an unsupported value in <see cref="VertexLayout.LayoutItem.AttribType"/>, <see cref="VertexLayout.LayoutItem.Components"/>, or <see cref="VertexLayout.LayoutItem.Usage"/>
 		/// </exception>
 		public Pipeline CreatePipeline(VertexLayout vertexLayout, Shader vertexShader, Shader fragmentShader, bool required, string memo)
 		{

src/BizHawk.Client.EmuHawk/tools/Lua/DelegatingLuaLibraryEmu.cs

@@ -6,7 +6,7 @@ using BizHawk.Client.Common;
 
 namespace BizHawk.Client.EmuHawk
 {
-	/// <summary>As <see cref="DelegatingLuaLibrary"/>, but also includes EmuHawk APIs via a <see cref="APIContainer"/>.</summary>
+	/// <summary>As <see cref="DelegatingLuaLibrary"/>, but also includes EmuHawk APIs via an <see cref="ApiContainer"/>.</summary>
 	public abstract class DelegatingLuaLibraryEmu : DelegatingLuaLibrary
 	{
 		protected DelegatingLuaLibraryEmu(Lua lua) : base(lua) {}

src/BizHawk.Common/CustomCollections.cs

@@ -7,7 +7,7 @@ using System.Runtime.Serialization;
 
 namespace BizHawk.Common
 {
-	/// <summary>Wrapper over <see cref="WorkingDictionary{TKey, TValue}">WorkingDictionary</see>&lt;<paramref name="TKey"/>, <see cref="List{T}">List</see>&lt;<paramref name="TValue"/>>>.</summary>
+	/// <summary>Wrapper over <see cref="WorkingDictionary{TKey, TValue}">WorkingDictionary</see>&lt;<typeparamref name="TKey"/>, <see cref="List{T}">List</see>&lt;<typeparamref name="TValue"/>>>.</summary>
 	[Serializable]
 	public class Bag<TKey, TValue> : IEnumerable<TValue> where TKey : notnull
 	{

src/BizHawk.Common/HawkFile/HawkArchiveFileItem.cs

@@ -4,7 +4,7 @@ namespace BizHawk.Common
 	public readonly struct HawkArchiveFileItem
 	{
 		/// <value>the index of the member within the archive, not to be confused with <see cref="Index"/></value>
-		/// <remarks>this is for <see cref="IFileDearchivalMethod"/> implementations to use internally</remarks>
+		/// <remarks>this is for <see cref="IFileDearchivalMethod{T}"/> implementations to use internally</remarks>
 		public readonly int ArchiveIndex;
 
 		/// <value>the index of this archive item</value>

src/BizHawk.Common/HawkFile/HawkFile.cs

@@ -16,7 +16,7 @@ namespace BizHawk.Common
 	/// Strings formatted this way are annotated <see cref="HawkFilePathAttribute">[HawkFilePath]</see>.
 	/// </summary>
 	/// <remarks>
-	/// This class is defensively designed around <see cref="IFileDearchivalMethod"/> to allow swapping out implementations (for speed) without adding any dependencies to this project.<br/>
+	/// This class is defensively designed around <see cref="IFileDearchivalMethod{T}"/> to allow swapping out implementations (for speed) without adding any dependencies to this project.<br/>
 	/// TODO split into "bind" and "open &lt;the bound thing>"<br/>
 	/// TODO scan archive to flatten interior directories down to a path (maintain our own archive item list)
 	/// </remarks>

src/BizHawk.Common/HawkFile/IHawkArchiveFile.cs

@@ -4,7 +4,7 @@ using System.IO;
 
 namespace BizHawk.Common
 {
-	/// <seealso cref="IFileDearchivalMethod"/>
+	/// <seealso cref="IFileDearchivalMethod{T}"/>
 	public interface IHawkArchiveFile : IDisposable
 	{
 		void ExtractFile(int index, Stream stream);

src/BizHawk.Common/Util.cs

@@ -38,7 +38,7 @@ namespace BizHawk.Common
 			return data;
 		}
 
-		/// <remarks>adapted from https://stackoverflow.com/a/3928856/7467292, values are compared using <see cref="EqualityComparer.Default">EqualityComparer.Default</see></remarks>
+		/// <remarks>adapted from https://stackoverflow.com/a/3928856/7467292, values are compared using <see cref="EqualityComparer{T}.Default">EqualityComparer.Default</see></remarks>
 		public static bool DictionaryEqual<TKey, TValue>(IDictionary<TKey, TValue> a, IDictionary<TKey, TValue> b)
 			where TKey : notnull
 		{

src/BizHawk.Emulation.Common/Interfaces/IEmulator.cs

@@ -27,7 +27,7 @@ namespace BizHawk.Emulation.Common
 		/// <summary>
 		/// 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 <seealso cref="renderSound"/> = false
+		/// please do this, even when <paramref name="renderSound"/> = false
 		/// <param name="controller">The <seealso cref="IController"/> instance that the core will use for input.
 		/// The <seealso cref="IController"/> provided by the client must provide the buttons specified by the core through the <seealso cref="ControllerDefinition"/> property
 		/// </param>

src/BizHawk.Emulation.Cores/Computers/MSX/LibMSX.cs

@@ -151,7 +151,6 @@ namespace BizHawk.Emulation.Cores.Computers.MSX
 		/// </summary>
 		/// <param name="core">opaque state pointer</param>
 		/// <param name="h">pointer to const char *</param>
-		/// <param name="callback">null to clear</param>
 		[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
 		/// </summary>
 		/// <param name="core">opaque state pointer</param>
-		/// <param name="r">pointer to const char *</param>
+		/// <param name="h">pointer to const char *</param>
 		/// <param name="t">call type</param>
 		/// <param name="l">copy length, must be obtained from appropriate get legnth function</param>
 		[DllImport("MSXHawk.dll", CallingConvention = CallingConvention.Cdecl)]
@@ -169,7 +168,7 @@ namespace BizHawk.Emulation.Cores.Computers.MSX
 		/// get the register state from the cpu
 		/// </summary>
 		/// <param name="core">opaque state pointer</param>
-		/// <param name="d">pointer to const char *</param>
+		/// <param name="h">pointer to const char *</param>
 		/// <param name="t">call type</param>
 		/// <param name="l">copy length, must be obtained from appropriate get legnth function</param>
 		[DllImport("MSXHawk.dll", CallingConvention = CallingConvention.Cdecl)]

src/BizHawk.Emulation.Cores/Consoles/Nintendo/Gameboy/LibGambatte.cs

@@ -208,7 +208,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.Gameboy
 		/// <summary>
 		/// type of the cpu trace callback
 		/// </summary>
-		/// <param name="data">cpu state</param>
+		/// <param name="state">cpu state</param>
 		[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
 		public delegate void TraceCallback(IntPtr state);
 

src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64.cs

@@ -22,7 +22,7 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64
 		/// Create mupen64plus Emulator
 		/// </summary>
 		/// <param name="game">Game information of game to load</param>
-		/// <param name="rom">Rom that should be loaded</param>
+		/// <param name="file">Rom that should be loaded</param>
 		/// <param name="syncSettings">N64SyncSettings object</param>
 		[CoreConstructor("N64")]
 		public N64(GameInfo game, byte[] file, object settings, object syncSettings)

src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64Audio.cs

@@ -39,7 +39,6 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64
 		/// <summary>
 		/// Creates a N64 Audio subsystem
 		/// </summary>
-		/// <param name="api">Mupen64 api which is used for fetching sound</param>
 		public N64Audio(mupen64plusApi core)
 		{
 			this.api = new mupen64plusAudioApi(core);

src/BizHawk.Emulation.Cores/Consoles/Nintendo/N64/N64VideoProvider.cs

@@ -15,7 +15,6 @@ namespace BizHawk.Emulation.Cores.Nintendo.N64
 		/// <summary>
 		/// Creates N64 Video system with mupen64plus backend
 		/// </summary>
-		/// <param name="api">mupen64plus DLL that is used</param>
 		public N64VideoProvider(mupen64plusApi core, VideoPluginSettings videosettings)
 		{
 			this.api = new mupen64plusVideoApi(core, videosettings);

src/BizHawk.Emulation.Cores/Sound/SyncSoundMixer.cs

@@ -81,7 +81,6 @@ namespace BizHawk.Emulation.Cores.Components
 		/// </summary>
 		/// <param name="source">The source ISoundProvider</param>
 		/// <param name="sourceDescription">An ident string for the ISoundProvider (useful when debugging)</param>
-		/// <param name="isMono">If this is true then only half the samples should be present</param>
 		public void PinSource(ISoundProvider source, string sourceDescription)
 		{
 			PinSource(source, sourceDescription, FinalMaxVolume);
@@ -93,7 +92,6 @@ namespace BizHawk.Emulation.Cores.Components
 		/// <param name="source">The source ISoundProvider</param>
 		/// <param name="sourceDescription">An ident string for the ISoundProvider (useful when debugging)</param>
 		/// <param name="sourceMaxVolume">The MaxVolume level for this particular ISoundProvider</param>
-		/// <param name="isMono">If this is true then only half the samples should be present</param>
 		public void PinSource(ISoundProvider source, string sourceDescription, short sourceMaxVolume)
 		{
 			_soundProviders.Add(new ChildProvider

src/BizHawk.Emulation.Cores/Sound/VRC6Alt.cs

@@ -14,7 +14,6 @@ namespace BizHawk.Emulation.Cores.Components
 
 		Action<int> enqueuer;
 
-		/// <param name="freq">frequency of the M2 clock in hz</param>
 		/// <param name="enqueuer">a place to dump deltas to</param>
 		public VRC6Alt(Action<int> enqueuer)
 		{

src/BizHawk.Emulation.DiscSystem/Internal/SynthUtils.cs

@@ -5,7 +5,7 @@ namespace BizHawk.Emulation.DiscSystem
 		/// <summary>
 		/// Calculates the checksum of the provided Q subchannel buffer and emplaces it
 		/// </summary>
-		/// <param name="buffer">12 byte Q subchannel buffer: input and output buffer for operation</param>
+		/// <param name="buf12">12 byte Q subchannel buffer: input and output buffer for operation</param>
 		/// <param name="offset">location within buffer of Q subchannel</param>
 		public static ushort SubQ_SynthChecksum(byte[] buf12, int offset)
 		{

src/BizHawk.WinForms.Controls/Docs.cs

@@ -41,7 +41,7 @@ namespace BizHawk.WinForms.Controls
 
 		/// <summary>
 		/// Inherits <see cref="FlowLayoutPanel"/>.
-		/// <see cref="FlowLayoutPanel.WrapContents"/> is locked to <see langword="true"/> and <see cref="FlowLayoutPanel.Margin"/> is locked to <see cref="Padding.Empty"/>.
+		/// <see cref="FlowLayoutPanel.WrapContents"/> is locked to <see langword="true"/> and <see cref="Control.Margin"/> is locked to <see cref="Padding.Empty"/>.
 		/// <see cref="FlowLayoutPanel.FlowDirection"/> is locked to <see cref="FlowDirection.LeftToRight"/>/<see cref="FlowDirection.TopDown"/> for rows/columns, respectively.
 		/// </summary>
 		/// <seealso cref="TypeNamePrefix">Naming convention for control types</seealso>
@@ -51,7 +51,7 @@ namespace BizHawk.WinForms.Controls
 
 		/// <summary>
 		/// Inherits <see cref="FlowLayoutPanel"/>.
-		/// <see cref="FlowLayoutPanel.WrapContents"/> is locked to <see langword="false"/> and <see cref="FlowLayoutPanel.Margin"/> is locked to <see cref="Padding.Empty"/>.
+		/// <see cref="FlowLayoutPanel.WrapContents"/> is locked to <see langword="false"/> and <see cref="Control.Margin"/> is locked to <see cref="Padding.Empty"/>.
 		/// <see cref="FlowLayoutPanel.FlowDirection"/> is locked to <see cref="FlowDirection.LeftToRight"/>/<see cref="FlowDirection.TopDown"/> for a single row/column, respectively.
 		/// </summary>
 		/// <seealso cref="TypeNamePrefix">Naming convention for control types</seealso>

src/MainSlnCommon.props

@@ -5,7 +5,7 @@
 		<CodeAnalysisRuleSet>$(ProjectDir)../../Common.ruleset</CodeAnalysisRuleSet>
 		<DocumentationFile>$(ProjectDir)bin/doc_comments.xml</DocumentationFile>
 		<MSBuildWarningsAsMessages>NU1702</MSBuildWarningsAsMessages>
-		<NoWarn>CS1572;CS1573;CS1574;CS1591;CS1734;NU1701</NoWarn>
+		<NoWarn>CS1573;CS1591;NU1701</NoWarn>
 		<OutputPath>$(ProjectDir)../../output/dll</OutputPath>
 	</PropertyGroup>
 	<ItemGroup>