Microsoft.Extensions.DependencyInjection.Specification.Tests is missing API documentation

[ViktorHofer]

See #84917 for more context.

The compiler generated XML file for Microsoft.Extensions.DependencyInjection.Specification.Tests is shipping to customers via the nuget package and is missing public API documentation. The above linked PR disables the compiler error CS1591 until all the API is documented.

When working on this, remove the NoWarn=1591 setting from the project file.

[ghost]

Tagging subscribers to this area: @dotnet/area-extensions-dependencyinjection
See info in area-owners.md if you want to be subscribed.

Issue Details

---

See #84917 for more context.

The compiler generated XML file for Microsoft.Extensions.DependencyInjection.Specification.Tests is shipping to customers via the nuget package and is missing public API documentation. The above linked PR disables the compiler error CS1591 until all the API is documented.

When working on this, remove the NoWarn=1591 setting from the project file.

Author:	ViktorHofer
Assignees:	-
Labels:	area-Extensions-DependencyInjection
Milestone:	-

[steveharter]

Is this worth it? Documenting the test types and individual tests? We could make the test methods non-public to avoid documenting each test.

[ViktorHofer]

It's probably not a priority. I don't know if we can make the test methods non-public. I thought those are the "public API" that other DI libraries test against.

[steveharter]

I believe a [Fact] test method can be private but the class must be public.

These are the tests that other DI implementations can use to test against, however the tests are self-describing and unless there is a real benefit to creating the doc and maintaining it, I suggest closing this issue.

[ViktorHofer]

That works for me.

Before closing though, consider updating this comment here:

runtime/src/libraries/Microsoft.Extensions.DependencyInjection.Specification.Tests/src/Microsoft.Extensions.DependencyInjection.Specification.Tests.csproj

Lines 12 to 13 in 45acd38

	<!-- Public API not fully documented. -->
	<NoWarn>$(NoWarn);1591</NoWarn>

[steveharter]

Just the comment needs to be updated - something like "Tests do not need to be documented."