search

dotnet / dotnet-api-docs

.NET API reference documentation (.NET 5+, .NET Core, .NET Framework)
https://docs.microsoft.com/dotnet/api/
Other
713 stars 1.56k forks source link

Microsoft.Extensions.DependencyModel should be documented #3418

Open MSDN-WhiteKnight opened 4 years ago

MSDN-WhiteKnight commented 4 years ago

There's a NuGet package Microsoft.Extensions.DependencyModel for reading .deps.json files at runtime. It is built from sources in core-setup now runtime repository. Currently there's no documentation for it. This package can be useful for developers who use Roslyn API to compile code targeting .NET Core (example: https://github.com/dotnet/core/issues/2082#issuecomment-442713181).

If this is supported library, i think it should be documented in .NET API Docs

Update: Now this library is shown in https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.dependencymodel?view=dotnet-plat-ext-5.0, but all descriptions are empty. Leaving this issue open to track filling API doc desriptions.

mairaw commented 4 years ago

@davidfowl @safern who can help with this request to add Microsoft.Extensions.DependencyModel to the API docs? This does show up as part of the platform extensions in the API catalog.

safern commented 4 years ago

The reason why this was not included is because we didn't consider the outputs of core-setup packages as a whole, only the shared framework. We should include packages produced as part of core-setup (now installer in the dotnet/runtime repo) as part of the docs and apisof.net set of assemblies.

ghost commented 2 years ago

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

Issue Details
There's a NuGet package [Microsoft.Extensions.DependencyModel](https://www.nuget.org/packages/Microsoft.Extensions.DependencyModel/) for reading *.deps.json* files at runtime. It is built from sources in [core-setup](https://github.com/dotnet/core-setup/tree/master/src/managed/Microsoft.Extensions.DependencyModel) repository. Currently there's no documentation for it. This package can be useful for developers who use Roslyn API to compile code targeting .NET Core (example: https://github.com/dotnet/core/issues/2082#issuecomment-442713181). If this is supported library, i think it should be documented in .NET API Docs
Author: MSDN-WhiteKnight
Assignees: -
Labels: `doc-idea`, `Pri3`, `area-Extensions-DependencyInjection`
Milestone: -