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.Configuration #43869

Closed
Tracked by #43849 ...
carlossanlop opened this issue Oct 27, 2020 · 5 comments · Fixed by dotnet/dotnet-api-docs#8546
Closed
Tracked by #43849 ...
Labels
area-Extensions-Configuration 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 @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
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.Configuration namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration?branch=master
M:Microsoft.Extensions.Configuration.BinderOptions.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/BinderOptions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.BinderOptions.-ctor?branch=master
M:Microsoft.Extensions.Configuration.ChainedConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ChainedConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ChainedConfigurationSource.-ctor?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationBuilder.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationBuilder.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationBuilder.-ctor?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1
(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})
Present Present Missing Present https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationExtensions.Add?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets
(Microsoft.Extensions.Configuration.IConfigurationBuilder)
Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets
(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly)
Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets
(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)
Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets``1
(Microsoft.Extensions.Configuration.IConfigurationBuilder)
Present Missing Present Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists
(Microsoft.Extensions.Configuration.IConfigurationSection)
Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationKeyComparer.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationKeyComparer.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationKeyComparer.-ctor?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationReloadToken.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationReloadToken.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationReloadToken.-ctor?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView
(Microsoft.Extensions.Configuration.IConfigurationRoot)
Present Missing NA Present https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationRootExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView?branch=master
M:Microsoft.Extensions.Configuration.FileConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/FileConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.FileConfigurationSource.-ctor?branch=master
M:Microsoft.Extensions.Configuration.FileLoadExceptionContext.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/FileLoadExceptionContext.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.FileLoadExceptionContext.-ctor?branch=master
M:Microsoft.Extensions.Configuration.StreamConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/StreamConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.StreamConfigurationSource.-ctor?branch=master
Microsoft.Extensions.Configuration.CommandLine
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.Configuration.CommandLine namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.CommandLine.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.CommandLine?branch=master
M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.CommandLine/CommandLineConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.-ctor?branch=master
Microsoft.Extensions.Configuration.CommandLine EnvironmentVariables Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.EnvironmentVariables.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.EnvironmentVariables?branch=master
M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.-ctor?branch=master
Microsoft.Extensions.Configuration.Ini
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.Configuration.Ini namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.Ini.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Ini?branch=master
M:Microsoft.Extensions.Configuration.Ini.IniConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Ini/IniConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Ini.IniConfigurationSource.-ctor?branch=master
M:Microsoft.Extensions.Configuration.Ini.IniStreamConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Ini/IniStreamConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Ini.IniStreamConfigurationSource.-ctor?branch=master
Microsoft.Extensions.Configuration.Json
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.Configuration.Json namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.Json.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Json?branch=master
M:Microsoft.Extensions.Configuration.Json.JsonConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Json/JsonConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Json.JsonConfigurationSource.-ctor?branch=master
M:Microsoft.Extensions.Configuration.Json.JsonStreamConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Json/JsonStreamConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Json.JsonStreamConfigurationSource.-ctor?branch=master
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
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.Configuration.NewtonsoftJson namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.NewtonsoftJson.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.NewtonsoftJson?branch=master
M:Microsoft.Extensions.Configuration.NewtonsoftJson.NewtonsoftJsonConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.NewtonsoftJson/NewtonsoftJsonConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.NewtonsoftJson.NewtonsoftJsonConfigurationSource.-ctor?branch=master
M:Microsoft.Extensions.Configuration.NewtonsoftJson.NewtonsoftJsonStreamConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.NewtonsoftJson/NewtonsoftJsonStreamConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.NewtonsoftJson.NewtonsoftJsonStreamConfigurationSource.-ctor?branch=master
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
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.Configuration.Xml namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.Xml.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Xml?branch=master
M:Microsoft.Extensions.Configuration.Xml.XmlConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Xml/XmlConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Xml.XmlConfigurationSource.-ctor?branch=master
M:Microsoft.Extensions.Configuration.Xml.XmlDocumentDecryptor.CreateDecryptingXmlReader(System.IO.Stream,System.Xml.XmlReaderSettings) Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Xml/XmlDocumentDecryptor.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Xml.XmlDocumentDecryptor.CreateDecryptingXmlReader?branch=master
M:Microsoft.Extensions.Configuration.Xml.XmlStreamConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Xml/XmlStreamConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Xml.XmlStreamConfigurationSource.-ctor?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
@ghost
Copy link

ghost commented Nov 5, 2020

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

@maryamariyan maryamariyan removed the untriaged New issue has not been triaged by the area owner label Nov 5, 2020
@ghost
Copy link

ghost commented Feb 2, 2021

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

Issue Details

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
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.Configuration namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration?branch=master
M:Microsoft.Extensions.Configuration.BinderOptions.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/BinderOptions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.BinderOptions.-ctor?branch=master
M:Microsoft.Extensions.Configuration.ChainedConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ChainedConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ChainedConfigurationSource.-ctor?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationBuilder.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationBuilder.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationBuilder.-ctor?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1
(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})
Present Present Missing Present https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationExtensions.Add?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets
(Microsoft.Extensions.Configuration.IConfigurationBuilder)
Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets
(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly)
Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets
(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)
Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets``1
(Microsoft.Extensions.Configuration.IConfigurationBuilder)
Present Missing Present Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationExtensions.AddUserSecrets?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists
(Microsoft.Extensions.Configuration.IConfigurationSection)
Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationKeyComparer.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationKeyComparer.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationKeyComparer.-ctor?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationReloadToken.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationReloadToken.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationReloadToken.-ctor?branch=master
M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView
(Microsoft.Extensions.Configuration.IConfigurationRoot)
Present Missing NA Present https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/ConfigurationRootExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView?branch=master
M:Microsoft.Extensions.Configuration.FileConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/FileConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.FileConfigurationSource.-ctor?branch=master
M:Microsoft.Extensions.Configuration.FileLoadExceptionContext.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/FileLoadExceptionContext.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.FileLoadExceptionContext.-ctor?branch=master
M:Microsoft.Extensions.Configuration.StreamConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration/StreamConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.StreamConfigurationSource.-ctor?branch=master
Microsoft.Extensions.Configuration.CommandLine
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.Configuration.CommandLine namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.CommandLine.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.CommandLine?branch=master
M:Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.CommandLine/CommandLineConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource.-ctor?branch=master
Microsoft.Extensions.Configuration.CommandLine EnvironmentVariables Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.EnvironmentVariables.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.EnvironmentVariables?branch=master
M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.EnvironmentVariables/EnvironmentVariablesConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.-ctor?branch=master
Microsoft.Extensions.Configuration.Ini
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.Configuration.Ini namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.Ini.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Ini?branch=master
M:Microsoft.Extensions.Configuration.Ini.IniConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Ini/IniConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Ini.IniConfigurationSource.-ctor?branch=master
M:Microsoft.Extensions.Configuration.Ini.IniStreamConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Ini/IniStreamConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Ini.IniStreamConfigurationSource.-ctor?branch=master
Microsoft.Extensions.Configuration.Json
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.Configuration.Json namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.Json.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Json?branch=master
M:Microsoft.Extensions.Configuration.Json.JsonConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Json/JsonConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Json.JsonConfigurationSource.-ctor?branch=master
M:Microsoft.Extensions.Configuration.Json.JsonStreamConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Json/JsonStreamConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Json.JsonStreamConfigurationSource.-ctor?branch=master
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
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.Configuration.NewtonsoftJson namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.NewtonsoftJson.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.NewtonsoftJson?branch=master
M:Microsoft.Extensions.Configuration.NewtonsoftJson.NewtonsoftJsonConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.NewtonsoftJson/NewtonsoftJsonConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.NewtonsoftJson.NewtonsoftJsonConfigurationSource.-ctor?branch=master
M:Microsoft.Extensions.Configuration.NewtonsoftJson.NewtonsoftJsonStreamConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.NewtonsoftJson/NewtonsoftJsonStreamConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.NewtonsoftJson.NewtonsoftJsonStreamConfigurationSource.-ctor?branch=master
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
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.Configuration.Xml namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.Configuration.Xml.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Xml?branch=master
M:Microsoft.Extensions.Configuration.Xml.XmlConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Xml/XmlConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Xml.XmlConfigurationSource.-ctor?branch=master
M:Microsoft.Extensions.Configuration.Xml.XmlDocumentDecryptor.CreateDecryptingXmlReader(System.IO.Stream,System.Xml.XmlReaderSettings) Present Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Xml/XmlDocumentDecryptor.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Xml.XmlDocumentDecryptor.CreateDecryptingXmlReader?branch=master
M:Microsoft.Extensions.Configuration.Xml.XmlStreamConfigurationSource.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.Configuration.Xml/XmlStreamConfigurationSource.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.Xml.XmlStreamConfigurationSource.-ctor?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.
Author: carlossanlop
Assignees: -
Labels:

area-Extensions-Configuration, documentation, up-for-grabs

Milestone: 6.0.0

@maryamariyan maryamariyan modified the milestones: 6.0.0, 7.0.0 Jul 22, 2021
@maryamariyan maryamariyan added help wanted [up-for-grabs] Good issue for external contributors and removed help wanted [up-for-grabs] Good issue for external contributors labels Dec 22, 2021
@tarekgh tarekgh removed this from the 7.0.0 milestone Aug 10, 2022
@tarekgh tarekgh added this to the Future milestone Aug 10, 2022
@maryamariyan maryamariyan modified the milestones: Future, 8.0.0 Oct 18, 2022
maryamariyan added a commit to maryamariyan/runtime that referenced this issue Oct 18, 2022
@maryamariyan
Copy link
Member

maryamariyan commented Oct 18, 2022

I did a quick skim over dotnet/runtime repo for

  • Microsoft.Extensions.Configuration
  • Microsoft.Extensions.Configuration.CommandLine
  • Microsoft.Extensions.Configuration.Ini
  • Microsoft.Extensions.Configuration.Json
  • Microsoft.Extensions.Configuration.Memory

and noticed no change is needed here. All listed APIs already have xml docs in the source code.

The default parameterless ctors maybe are just missing in the dotnet-api-docs repo itself. No action needed on dotnet/runtime repo side.

Also note, Microsoft.Extensions.Configuration.NewtonsoftJson source code does not live in dotnet/runtime.

@KalleOlaviNiemitalo
Copy link

KalleOlaviNiemitalo commented Oct 19, 2022

While implementing Microsoft.Extensions.Configuration.IConfiguration, I did not find any documentation on the following:

@maryamariyan
Copy link
Member

Thanks @KalleOlaviNiemitalo. This issue tracks APIs with no documentation on them.

I added issue dotnet/dotnet-api-docs#8549 to track your feedback,

@ghost ghost locked as resolved and limited conversation to collaborators Nov 21, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-Extensions-Configuration 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.

6 participants