Backfill XML docs on all the context objects

src/xunit.analyzers/Utility/EmptyAssertContext.cs

@@ -1,3 +1,5 @@
+using System;
+
 namespace Xunit.Analyzers;
 
 public class EmptyAssertContext : IAssertContext
@@ -8,4 +10,6 @@ public class EmptyAssertContext : IAssertContext
 	public static EmptyAssertContext Instance { get; } = new();
 
 	public bool SupportsAssertFail => false;
+
+	public Version Version { get; } = new();
 }

src/xunit.analyzers/Utility/EmptyCoreContext.cs

@@ -1,3 +1,4 @@
+using System;
 using Microsoft.CodeAnalysis;
 
 namespace Xunit.Analyzers;
@@ -36,4 +37,6 @@ public class EmptyCoreContext : ICoreContext
 	public bool TheorySupportsDefaultParameterValues => false;
 
 	public bool TheorySupportsParameterArrays => false;
+
+	public Version Version { get; } = new();
 }

src/xunit.analyzers/Utility/IAssertContext.cs

@@ -1,6 +1,16 @@
+using System;
+
 namespace Xunit.Analyzers;
 
 public interface IAssertContext
 {
+	/// <summary>
+	/// Gets a flag indicating whether <c>Assert.Fail</c> is supported.
+	/// </summary>
 	bool SupportsAssertFail { get; }
+
+	/// <summary>
+	/// Gets the version number of the assertion assembly.
+	/// </summary>
+	Version Version { get; }
 }

src/xunit.analyzers/Utility/ICoreContext.cs

@@ -1,34 +1,85 @@
+using System;
 using Microsoft.CodeAnalysis;
 
 namespace Xunit.Analyzers;
 
 public interface ICoreContext
 {
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.ClassDataAttribute</c>, if available.
+	/// </summary>
 	INamedTypeSymbol? ClassDataAttributeType { get; }
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.CollectionAttribute</c>, if available.
+	/// </summary>
 	INamedTypeSymbol? CollectionAttributeType { get; }
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.CollectionDefinitionAttribute</c>, if available.
+	/// </summary>
 	INamedTypeSymbol? CollectionDefinitionAttributeType { get; }
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Sdk.DataAttribute</c>, if available.
+	/// </summary>
 	INamedTypeSymbol? DataAttributeType { get; }
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.FactAttribute</c>, if available.
+	/// </summary>
 	INamedTypeSymbol? FactAttributeType { get; }
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.IClassFixture&lt;T&gt;</c>, if available.
+	/// </summary>
 	INamedTypeSymbol? IClassFixtureType { get; }
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.ICollectionFixture&lt;T&gt;</c>, if available.
+	/// </summary>
 	INamedTypeSymbol? ICollectionFixtureType { get; }
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.InlineDataAttribute</c>, if available.
+	/// </summary>
 	INamedTypeSymbol? InlineDataAttributeType { get; }
 
+	// TODO: This will need to be updated when v3 names are finalized
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ITestOutputHelper</c> (v2)
+	/// or <c>Xunit.v3._ITestOutputHelper</c>, if available.
+	/// </summary>
 	INamedTypeSymbol? ITestOutputHelperType { get; }
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.MemberDataAttribute</c>, if available.
+	/// </summary>
 	INamedTypeSymbol? MemberDataAttributeType { get; }
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.TheoryAttribute</c>, if available.
+	/// </summary>
 	INamedTypeSymbol? TheoryAttributeType { get; }
 
+	/// <summary>
+	/// Gets a flag indicating whether theory data can be automatically converted from a <see cref="string"/>
+	/// value into a <see cref="DateTimeOffset"/> or a <see cref="Guid"/>.
+	/// </summary>
 	bool TheorySupportsConversionFromStringToDateTimeOffsetAndGuid { get; }
 
+	/// <summary>
+	/// Gets a flag indicating whether theory methods support default parameter values.
+	/// </summary>
 	bool TheorySupportsDefaultParameterValues { get; }
 
+	/// <summary>
+	/// Gets a flag indicating whether theory methods support params arrays.
+	/// </summary>
 	bool TheorySupportsParameterArrays { get; }
+
+	/// <summary>
+	/// Gets the version number of the core assembly.
+	/// </summary>
+	Version Version { get; }
 }

src/xunit.analyzers/Utility/TypeSymbolFactory.cs

@@ -75,15 +75,15 @@ public static INamedTypeSymbol IEnumerableOfObjectArray(Compilation compilation)
 		return iEnumerableOfT.Construct(iTheoryDataRow);
 	}
 
-	public static INamedTypeSymbol? IMethodInfo_V2(Compilation compilation) =>
-		compilation.GetTypeByMetadataName("Xunit.Abstractions.IMethodInfo");
-
 	public static INamedTypeSymbol? IMessageSink_V2(Compilation compilation) =>
 		compilation.GetTypeByMetadataName("Xunit.Abstractions.IMessageSink");
 
 	public static INamedTypeSymbol? IMessageSinkMessage_V2(Compilation compilation) =>
 		compilation.GetTypeByMetadataName("Xunit.Abstractions.IMessageSinkMessage");
 
+	public static INamedTypeSymbol? IMethodInfo_V2(Compilation compilation) =>
+		compilation.GetTypeByMetadataName("Xunit.Abstractions.IMethodInfo");
+
 	public static INamedTypeSymbol? InlineDataAttribute(Compilation compilation) =>
 		compilation.GetTypeByMetadataName("Xunit.InlineDataAttribute");
 

src/xunit.analyzers/Utility/V2AbstractionsContext.cs

@@ -53,63 +53,123 @@ public class V2AbstractionsContext
 		lazyIXunitSerializableType = new(() => TypeSymbolFactory.IXunitSerializable_V2(compilation));
 	}
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.IAssemblyInfo</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? IAssemblyInfoType =>
 		lazyIAssemblyInfoType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.IAttributeInfo</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? IAttributeInfoType =>
 		lazyIAttributeInfoType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.IMessageSinkMessage</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? IMessageSinkMessageType =>
 		lazyIMessageSinkMessageType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.IMessageSink</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? IMessageSinkType =>
 		lazyIMessageSinkType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.IMethodInfo</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? IMethodInfoType =>
 		lazyIMethodInfoType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.IParameterInfo</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? IParameterInfoType =>
 		lazyIParameterInfoType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ISourceInformationProvider</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? ISourceInformationProviderType =>
 		lazyISourceInformationProviderType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ISourceInformation</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? ISourceInformationType =>
 		lazyISourceInformationType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ITestAssembly</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? ITestAssemblyType =>
 		lazyITestAssemblyType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ITestCase</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? ITestCaseType =>
 		lazyITestCaseType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ITestClass</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? ITestClassType =>
 		lazyITestClassType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ITestCollection</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? ITestCollectionType =>
 		lazyITestCollectionType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ITestFrameworkDiscoverer</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? ITestFrameworkDiscovererType =>
 		lazyITestFrameworkDiscovererType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ITestFrameworkExecutor</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? ITestFrameworkExecutorType =>
 		lazyITestFrameworkExecutorType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ITestFramework</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? ITestFrameworkType =>
 		lazyITestFrameworkType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ITestMethod</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? ITestMethodType =>
 		lazyITestMethodType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ITest</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? ITestType =>
 		lazyITestType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ITypeInfo</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? ITypeInfoType =>
 		lazyITypeInfoType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.IXunitSerializable</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? IXunitSerializableType =>
 		lazyIXunitSerializableType.Value;
 
+	/// <summary>
+	/// Gets the version number of the abstractions assembly.
+	/// </summary>
 	public Version Version { get; }
 
 	public static V2AbstractionsContext? Get(

src/xunit.analyzers/Utility/V2AssertContext.cs

@@ -13,10 +13,12 @@ public class V2AssertContext : IAssertContext
 		Version = version;
 	}
 
+	/// <inheritdoc/>
 	public bool SupportsAssertFail =>
 		Version >= Version_2_5_0;
 
-	public Version Version { get; set; }
+	/// <inheritdoc/>
+	public Version Version { get; }
 
 	public static V2AssertContext? Get(
 		Compilation compilation,

src/xunit.analyzers/Utility/V2CoreContext.cs

@@ -40,50 +40,67 @@ public class V2CoreContext : ICoreContext
 		lazyTheoryAttributeType = new(() => TypeSymbolFactory.TheoryAttribute(compilation));
 	}
 
+	/// <inheritdoc/>
 	public INamedTypeSymbol? ClassDataAttributeType =>
 		lazyClassDataAttributeType.Value;
 
+	/// <inheritdoc/>
 	public INamedTypeSymbol? CollectionAttributeType =>
 		lazyCollectionAttributeType.Value;
 
+	/// <inheritdoc/>
 	public INamedTypeSymbol? CollectionDefinitionAttributeType =>
 		lazyCollectionDefinitionAttributeType.Value;
 
+	/// <inheritdoc/>
 	public INamedTypeSymbol? DataAttributeType =>
 		lazyDataAttributeType.Value;
 
+	/// <inheritdoc/>
 	public INamedTypeSymbol? FactAttributeType =>
 		lazyFactAttributeType.Value;
 
+	/// <inheritdoc/>
 	public INamedTypeSymbol? IClassFixtureType =>
 		lazyIClassFixtureType.Value;
 
+	/// <inheritdoc/>
 	public INamedTypeSymbol? ICollectionFixtureType =>
 		lazyICollectionFixtureType.Value;
 
+	/// <inheritdoc/>
 	public INamedTypeSymbol? InlineDataAttributeType =>
 		lazyInlineDataAttributeType.Value;
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Abstractions.ITestOutputHelper</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? ITestOutputHelperType =>
 		lazyITestOutputHelperType.Value;
 
+	/// <inheritdoc/>
 	public INamedTypeSymbol? MemberDataAttributeType =>
 		lazyMemberDataAttributeType.Value;
 
+	/// <inheritdoc/>
 	public INamedTypeSymbol? TheoryAttributeType =>
 		lazyTheoryAttributeType.Value;
 
 	// See: https://github.com/xunit/xunit/pull/1546
+	/// <inheritdoc/>
 	public bool TheorySupportsConversionFromStringToDateTimeOffsetAndGuid =>
 		Version >= Version_2_4_0;
 
+	/// <inheritdoc/>
 	public bool TheorySupportsDefaultParameterValues =>
 		Version >= Version_2_2_0;
 
+	/// <inheritdoc/>
 	public bool TheorySupportsParameterArrays =>
 		Version >= Version_2_2_0;
 
-	public Version Version { get; set; }
+	/// <inheritdoc/>
+	public Version Version { get; }
 
 	public static V2CoreContext? Get(
 		Compilation compilation,

src/xunit.analyzers/Utility/V2ExecutionContext.cs

@@ -20,11 +20,21 @@ public class V2ExecutionContext
 		lazyLongLivedMarshalByRefObjectType = new(() => TypeSymbolFactory.LongLivedMarshalByRefObject_ExecutionV2(compilation));
 	}
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.LongLivedMarshalByRefObject</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? LongLivedMarshalByRefObjectType =>
 		lazyLongLivedMarshalByRefObjectType.Value;
 
+	/// <summary>
+	/// Gets a description of the target platform for the execution library (i.e., "desktop"). This is
+	/// typically extracted from the assembly name (i.e., "xunit.execution.desktop").
+	/// </summary>
 	public string Platform { get; }
 
+	/// <summary>
+	/// Gets the version number of the execution assembly.
+	/// </summary>
 	public Version Version { get; }
 
 	public static V2ExecutionContext? Get(

src/xunit.analyzers/Utility/V2RunnerUtilityContext.cs

@@ -20,11 +20,16 @@ public class V2RunnerUtilityContext : IRunnerUtilityContext
 		lazyLongLivedMarshalByRefObjectType = new(() => TypeSymbolFactory.LongLivedMarshalByRefObject_RunnerUtilityV2(compilation));
 	}
 
+	/// <summary>
+	/// Gets a reference to type <c>Xunit.Sdk.LongLivedMarshalByRefObject</c>, if available.
+	/// </summary>
 	public INamedTypeSymbol? LongLivedMarshalByRefObjectType =>
 		lazyLongLivedMarshalByRefObjectType.Value;
 
+	/// <inheritdoc/>
 	public string Platform { get; }
 
+	/// <inheritdoc/>
 	public Version Version { get; }
 
 	public static V2RunnerUtilityContext? Get(