Apply `<GenerateDocumentationFile/>` to satellite .NET projects

This commit is contained in:
YoshiRulz 2024-05-30 05:56:36 +10:00
parent 431b4f67e8
commit b8c600783a
No known key found for this signature in database
GPG Key ID: C4DE31C245353FB7
8 changed files with 10 additions and 12 deletions

View File

@ -16,9 +16,10 @@
<ErrorReport>prompt</ErrorReport> <ErrorReport>prompt</ErrorReport>
<Features>strict</Features> <Features>strict</Features>
<IsTargetingNetFramework>$(TargetFramework.StartsWith("net4"))</IsTargetingNetFramework> <IsTargetingNetFramework>$(TargetFramework.StartsWith("net4"))</IsTargetingNetFramework>
<GenerateDocumentationFile>true</GenerateDocumentationFile> <!-- it would be nice to rename these to *.api_reference.xml or something, but it seems https://github.com/dotnet/standard/issues/614 was never fixed -->
<LangVersion>10.0</LangVersion> <LangVersion>10.0</LangVersion>
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally> <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
<NoWarn>SA0001</NoWarn> <NoWarn>$(NoWarn);CS1591;SA0001</NoWarn>
<Nullable>enable</Nullable> <Nullable>enable</Nullable>
<PlatformTarget>AnyCPU</PlatformTarget> <PlatformTarget>AnyCPU</PlatformTarget>
<RunAnalyzersDuringBuild>true</RunAnalyzersDuringBuild> <RunAnalyzersDuringBuild>true</RunAnalyzersDuringBuild>

View File

@ -4,7 +4,6 @@ using System.Collections.Immutable;
using System.Linq; using System.Linq;
using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.Diagnostics; using Microsoft.CodeAnalysis.Diagnostics;
using Microsoft.CodeAnalysis.Operations; using Microsoft.CodeAnalysis.Operations;

View File

@ -89,6 +89,7 @@ namespace ISOParser
/// </summary> /// </summary>
/// <param name="s">The stream which we are using to parse the image. /// <param name="s">The stream which we are using to parse the image.
/// Should already be located at the start of the image.</param> /// Should already be located at the start of the image.</param>
/// <param name="startSector">will seek forward this number of sectors before reading</param>
public bool Parse(Stream s, int startSector = 16) public bool Parse(Stream s, int startSector = 16)
{ {
this.VolumeDescriptors = new List<ISOVolumeDescriptor>(); this.VolumeDescriptors = new List<ISOVolumeDescriptor>();

View File

@ -171,6 +171,7 @@ namespace BizHawk.Experiment.AutoGenConfig
public readonly ComparisonColors ComparisonColors; public readonly ComparisonColors ComparisonColors;
/// <param name="cache">global cache</param>
/// <param name="colors">default of <see langword="null"/> uses <see cref="ConfigEditorUIGenerators.ComparisonColors.Defaults"/></param> /// <param name="colors">default of <see langword="null"/> uses <see cref="ConfigEditorUIGenerators.ComparisonColors.Defaults"/></param>
public ConfigEditorMetadata(ConfigEditorCache cache, ComparisonColors? colors = null) public ConfigEditorMetadata(ConfigEditorCache cache, ComparisonColors? colors = null)
{ {
@ -209,7 +210,7 @@ namespace BizHawk.Experiment.AutoGenConfig
/// <remarks> /// <remarks>
/// Default implementation didn't play nice with <see langword="null"/>, so multiple behaviours are available for custom generators: /// Default implementation didn't play nice with <see langword="null"/>, so multiple behaviours are available for custom generators:
/// inherit from <see cref="ConfigPropEditorUIGenRefT"/> or <see cref="ConfigPropEditorUIGenValT"/> instead. /// inherit from <see cref="ConfigPropEditorUIGenRefT{T,T}"/> or <see cref="ConfigPropEditorUIGenValT{T,T}"/> instead.
/// </remarks> /// </remarks>
protected abstract bool MatchesBaseline(TListed c, ConfigEditorMetadata metadata); protected abstract bool MatchesBaseline(TListed c, ConfigEditorMetadata metadata);
@ -273,12 +274,12 @@ namespace BizHawk.Experiment.AutoGenConfig
where TValue : class where TValue : class
{ {
/// <remarks> /// <remarks>
/// Checked in <see cref="MatchesBaseline"/> in the case where the baseline value is <see cref="null"/>. /// Checked in <see cref="MatchesBaseline"/> in the case where the baseline value is <see langword="null"/>.
/// If its implementation returns <see cref="false"/>, an exception will be thrown, otherwise <see cref="TValueEquality"/>' implementation will be called with <see cref="null"/>. /// If its implementation returns <see langword="false"/>, an exception will be thrown, otherwise <see cref="ConfigPropEditorUIGen{T,T}.TValueEquality"/>' implementation will be called with <see langword="null"/>.
/// </remarks> /// </remarks>
protected abstract bool AllowNull { get; } protected abstract bool AllowNull { get; }
/// <inheritdoc cref="ConfigPropEditorUIGen.MatchesBaseline"/> /// <inheritdoc cref="ConfigPropEditorUIGen{T,T}.MatchesBaseline"/>
protected override bool MatchesBaseline(TListed c, ConfigEditorMetadata metadata) protected override bool MatchesBaseline(TListed c, ConfigEditorMetadata metadata)
=> metadata.BaselineValues[c.Name] is TValue v => metadata.BaselineValues[c.Name] is TValue v
? TValueEquality(GetTValue(c), v) ? TValueEquality(GetTValue(c), v)
@ -289,7 +290,7 @@ namespace BizHawk.Experiment.AutoGenConfig
where TListed : Control where TListed : Control
where TValue : struct where TValue : struct
{ {
/// <inheritdoc cref="ConfigPropEditorUIGen.MatchesBaseline"/> /// <inheritdoc cref="ConfigPropEditorUIGen{T,T}.MatchesBaseline"/>
protected override bool MatchesBaseline(TListed c, ConfigEditorMetadata metadata) protected override bool MatchesBaseline(TListed c, ConfigEditorMetadata metadata)
=> metadata.BaselineValues[c.Name] is TValue v ? TValueEquality(GetTValue(c), v) : throw new Exception(); => metadata.BaselineValues[c.Name] is TValue v ? TValueEquality(GetTValue(c), v) : throw new Exception();
} }

View File

@ -6,9 +6,6 @@ using System.Linq;
using System.Windows.Forms; using System.Windows.Forms;
using System.IO; using System.IO;
using BizHawk.Client.Common;
using BizHawk.Client.EmuHawk;
namespace BizHawk.DATTool namespace BizHawk.DATTool
{ {
public partial class DATConverter : Form public partial class DATConverter : Form

Binary file not shown.

Binary file not shown.

View File

@ -4,9 +4,8 @@
<AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath> <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
<DebugType>embedded</DebugType> <DebugType>embedded</DebugType>
<DefineConstants>$(DefineConstants);AVI_SUPPORT</DefineConstants> <DefineConstants>$(DefineConstants);AVI_SUPPORT</DefineConstants>
<GenerateDocumentationFile>true</GenerateDocumentationFile> <!-- it would be nice to rename these to *.api_reference.xml or something, but it seems https://github.com/dotnet/standard/issues/614 was never fixed -->
<LangVersion>12.0</LangVersion> <LangVersion>12.0</LangVersion>
<NoWarn>$(NoWarn);CS1573;CS1591;NU1702</NoWarn> <NoWarn>$(NoWarn);CS1573;NU1702</NoWarn>
<ResolveAssemblyWarnOrErrorOnTargetArchitectureMismatch>None</ResolveAssemblyWarnOrErrorOnTargetArchitectureMismatch> <ResolveAssemblyWarnOrErrorOnTargetArchitectureMismatch>None</ResolveAssemblyWarnOrErrorOnTargetArchitectureMismatch>
</PropertyGroup> </PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)' == 'Release' And '$(SolutionDir)' != '' "> <PropertyGroup Condition=" '$(Configuration)' == 'Release' And '$(SolutionDir)' != '' ">