-
Notifications
You must be signed in to change notification settings - Fork 5.4k
Closed
dotnet/dotnet-api-docs
#8546Labels
area-Extensions-ConfigurationdocumentationDocumentation bug or enhancement, does not impact product or test codeDocumentation bug or enhancement, does not impact product or test codehelp wanted[up-for-grabs] Good issue for external contributors[up-for-grabs] Good issue for external contributors
Milestone
Description
Area owners: @maryamariyan @safern
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.Configuration
Microsoft.Extensions.Configuration.CommandLine
Microsoft.Extensions.Configuration.Ini
Microsoft.Extensions.Configuration.Json
Microsoft.Extensions.Configuration.Memory
| DocId | Summary | Parameters | TypeParameters | ReturnValue | Source File Path | Docs URL |
|---|---|---|---|---|---|---|
| Microsoft.Extensions.Configuration.Memory namespace | Missing | NA | NA | NA | https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.Memory.xml | https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Memory?branch=master |
| M:Microsoft.Extensions.Configuration.Memory.MemoryConfigurationSource.#ctor | Missing | NA | NA | NA | https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Memory/MemoryConfigurationSource.xml | https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Memory.MemoryConfigurationSource.-ctor?branch=master |
Microsoft.Extensions.Configuration.NewtonsoftJson
Microsoft.Extensions.Configuration.UserSecrets
| DocId | Summary | Parameters | TypeParameters | ReturnValue | Source File Path | Docs URL |
|---|---|---|---|---|---|---|
| Microsoft.Extensions.Configuration.UserSecrets namespace | Missing | NA | NA | NA | https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.UserSecrets.xml | https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.UserSecrets?branch=master |
| M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.#ctor | Missing | NA | NA | NA | https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.UserSecrets/PathHelper.xml | https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.UserSecrets.PathHelper.-ctor?branch=master |
Microsoft.Extensions.Configuration.Xml
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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
area-Extensions-ConfigurationdocumentationDocumentation bug or enhancement, does not impact product or test codeDocumentation bug or enhancement, does not impact product or test codehelp wanted[up-for-grabs] Good issue for external contributors[up-for-grabs] Good issue for external contributors