Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API documentation debt - Microsoft.Extensions.DependencyInjection #43871

Closed
Tracked by #43849
carlossanlop opened this issue Oct 27, 2020 · 1 comment · Fixed by #76940
Closed
Tracked by #43849

API documentation debt - Microsoft.Extensions.DependencyInjection #43871

carlossanlop opened this issue Oct 27, 2020 · 1 comment · Fixed by #76940
Assignees
Labels
area-Extensions-DependencyInjection documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Milestone

Comments

@carlossanlop
Copy link
Member

Area owners: @maryamariyan @eerhardt

The APIs in the list below are missing some or all of their documentation. Please add the missing documentation directly in triple slash comments in source. We will make sure it gets ported to dotnet-api-docs after it's merged.

Make sure to follow the documentation guidelines defined in the dotnet-api-docs wiki:
https://github.com/dotnet/dotnet-api-docs/wiki

Also please add me as a PR reviewer.

Community contributions are welcome.

Microsoft.Extensions.DependencyInjection
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.DependencyInjection namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.DependencyInjection.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection?branch=master
M:Microsoft.Extensions.DependencyInjection.ActivatorUtilitiesConstructorAttribute.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ActivatorUtilitiesConstructorAttribute.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ActivatorUtilitiesConstructorAttribute.-ctor?branch=master
M:Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory.CreateBuilder
(Microsoft.Extensions.DependencyInjection.IServiceCollection)
Present Missing NA Present https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory.CreateBuilder?branch=master
M:Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory.CreateServiceProvider
(Microsoft.Extensions.DependencyInjection.IServiceCollection)
Present Missing NA Present https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.DefaultServiceProviderFactory.CreateServiceProvider?branch=master
M:Microsoft.Extensions.DependencyInjection.EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck``1
(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Nullable
{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String},System.Func
{``0,System.Threading.CancellationToken,System.Threading.Tasks.Task{System.Boolean}})
Missing Missing Missing Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/EntityFrameworkCoreHealthChecksBuilderExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.EntityFrameworkCoreHealthChecksBuilderExtensions.AddDbContextCheck?branch=master
T:Microsoft.Extensions.DependencyInjection.EntityFrameworkCoreHealthChecksBuilderExtensions Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/EntityFrameworkCoreHealthChecksBuilderExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.EntityFrameworkCoreHealthChecksBuilderExtensions?branch=master
M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``2
(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)
Present Present Present Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/HttpClientBuilderExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient?branch=master
M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1
(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder)
Present Present Present Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/HttpClientBuilderExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient?branch=master
M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1
(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.HttpClient,System.IServiceProvider,``0})
Present Present Present Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/HttpClientBuilderExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient?branch=master
M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient``1
(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Func{System.Net.Http.HttpClient,``0})
Present Present Present Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/HttpClientBuilderExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.AddTypedClient?branch=master
M:Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.SetHandlerLifetime
(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.TimeSpan)
Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/HttpClientBuilderExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.HttpClientBuilderExtensions.SetHandlerLifetime?branch=master
M:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder.Add
(Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration)
Present Present NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/IHealthChecksBuilder.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder.Add?branch=master
T:Microsoft.Extensions.DependencyInjection.IServiceProviderFactory`1 Present NA Missing NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/IServiceProviderFactory`1.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.IServiceProviderFactory-1?branch=master
M:Microsoft.Extensions.DependencyInjection.ServiceCollection.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceCollection.-ctor?branch=master
M:Microsoft.Extensions.DependencyInjection.ServiceCollection.Contains
(Microsoft.Extensions.DependencyInjection.ServiceDescriptor)
Present Missing NA Present https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceCollection.Contains?branch=master
M:Microsoft.Extensions.DependencyInjection.ServiceCollection.CopyTo
(Microsoft.Extensions.DependencyInjection.ServiceDescriptor[],System.Int32)
Present Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceCollection.CopyTo?branch=master
M:Microsoft.Extensions.DependencyInjection.ServiceCollection.IndexOf
(Microsoft.Extensions.DependencyInjection.ServiceDescriptor)
Present Missing NA Present https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceCollection.IndexOf?branch=master
M:Microsoft.Extensions.DependencyInjection.ServiceCollection.Insert
(System.Int32,Microsoft.Extensions.DependencyInjection.ServiceDescriptor)
Present Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceCollection.Insert?branch=master
P:Microsoft.Extensions.DependencyInjection.ServiceCollection.Item(System.Int32) Present Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceCollection.Item?branch=master
M:Microsoft.Extensions.DependencyInjection.ServiceCollection.Remove
(Microsoft.Extensions.DependencyInjection.ServiceDescriptor)
Present Missing NA Present https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceCollection.Remove?branch=master
M:Microsoft.Extensions.DependencyInjection.ServiceCollection.RemoveAt(System.Int32) Present Missing NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceCollection.RemoveAt?branch=master
T:Microsoft.Extensions.DependencyInjection.ServiceCollectionHostedServiceExtensions Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceCollectionHostedServiceExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceCollectionHostedServiceExtensions?branch=master
M:Microsoft.Extensions.DependencyInjection.ServiceCollectionServiceExtensions.AddSingleton``1
(Microsoft.Extensions.DependencyInjection.IServiceCollection,``0)
Present Present Missing Present https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceCollectionServiceExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceCollectionServiceExtensions.AddSingleton?branch=master
P:Microsoft.Extensions.DependencyInjection.ServiceDescriptor.ImplementationFactory Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceDescriptor.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceDescriptor.ImplementationFactory?branch=master
P:Microsoft.Extensions.DependencyInjection.ServiceDescriptor.ImplementationInstance Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceDescriptor.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceDescriptor.ImplementationInstance?branch=master
P:Microsoft.Extensions.DependencyInjection.ServiceDescriptor.ImplementationType Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceDescriptor.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceDescriptor.ImplementationType?branch=master
P:Microsoft.Extensions.DependencyInjection.ServiceDescriptor.Lifetime Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceDescriptor.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceDescriptor.Lifetime?branch=master
P:Microsoft.Extensions.DependencyInjection.ServiceDescriptor.ServiceType Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceDescriptor.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceDescriptor.ServiceType?branch=master
M:Microsoft.Extensions.DependencyInjection.ServiceDescriptor.ToString Missing NA NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceDescriptor.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceDescriptor.ToString?branch=master
M:Microsoft.Extensions.DependencyInjection.ServiceProviderOptions.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection/ServiceProviderOptions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.ServiceProviderOptions.-ctor?branch=master
Microsoft.Extensions.DependencyInjection.Extensions
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL

Microsoft.Extensions.DependencyInjection.Extensions namespace | Missing | NA | NA | NA | https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.DependencyInjection.Extensions.xml | https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.Extensions?branch=master
M:Microsoft.Extensions.DependencyInjection.Extensions.ServiceCollectionDescriptorExtensions.RemoveAll``1
(Microsoft.Extensions.DependencyInjection.IServiceCollection) | Present | Present | Missing | Present | https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.DependencyInjection.Extensions/ServiceCollectionDescriptorExtensions.xml | https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.Extensions.ServiceCollectionDescriptorExtensions.RemoveAll?branch=master

Notes:

  • The namespaces need to be documented directly in dotnet-api-docs.
  • Some of the APIs are obsolete, so I'll let area owners decide if they want to still document them or skip them. If you opt for documenting them, please do it directly in dotnet-api-docs.
@carlossanlop carlossanlop added documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors untriaged New issue has not been triaged by the area owner area-Microsoft.Extensions labels Oct 27, 2020
@carlossanlop carlossanlop added this to the 6.0.0 milestone Oct 27, 2020
@maryamariyan maryamariyan added area-Extensions-DependencyInjection and removed untriaged New issue has not been triaged by the area owner labels Nov 5, 2020
@ghost
Copy link

ghost commented Nov 5, 2020

Tagging subscribers to this area: @eerhardt, @maryamariyan
See info in area-owners.md if you want to be subscribed.

@eerhardt eerhardt modified the milestones: 6.0.0, 7.0.0 Jul 14, 2021
@tarekgh tarekgh modified the milestones: 7.0.0, Future Aug 10, 2022
@Nick-Stanton Nick-Stanton self-assigned this Oct 6, 2022
@Nick-Stanton Nick-Stanton linked a pull request Oct 17, 2022 that will close this issue
@ghost ghost locked as resolved and limited conversation to collaborators Nov 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-Extensions-DependencyInjection documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants