search

dotnet / runtime

.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.
https://docs.microsoft.com/dotnet/core/
MIT License
15.16k stars 4.71k forks source link

API documentation debt - System.ServiceModel #43855

Open carlossanlop opened 3 years ago

carlossanlop commented 3 years ago

Area owners: @HongGit @mconnew

The APIs in the list below are missing some or all of their documentation. For this particular namespace, please add the missing documentation directly in dotnet-api-docs. The table below will let you know the location of the xml file where the API lives.

Please 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.

System.ServiceModel DocId | Summary | Parameters | TypeParameters | ReturnValue | Source File Path | Docs URL -- | -- | -- | -- | -- | -- | -- M:System.ServiceModel.Channels.BindingParameterCollection.GetKeyForItem(System.Object) | Missing | Missing | NA | Missing | https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.ServiceModel.Channels/BindingParameterCollection.xml | https://review.docs.microsoft.com/en-us/dotnet/api/System.ServiceModel.Channels.BindingParameterCollection.GetKeyForItem?branch=master M:System.ServiceModel.Channels.BindingParameterCollection.InsertItem(System.Int32,System.Object) | Missing | Missing | NA | NA | https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.ServiceModel.Channels/BindingParameterCollection.xml | https://review.docs.microsoft.com/en-us/dotnet/api/System.ServiceModel.Channels.BindingParameterCollection.InsertItem?branch=master M:System.ServiceModel.Channels.BindingParameterCollection.SetItem(System.Int32,System.Object) | Missing | Missing | NA | NA | https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.ServiceModel.Channels/BindingParameterCollection.xml | https://review.docs.microsoft.com/en-us/dotnet/api/System.ServiceModel.Channels.BindingParameterCollection.SetItem?branch=master
mconnew commented 3 years ago

@carlossanlop, the source code the WCF isn't in this repo, it's in the dotnet/wcf repo. Just want to make sure the process to grab the documentation from the source code will be scanning the wcf repo and not be looking for it in this repo?

carlossanlop commented 3 years ago

@mconnew I didn't know the source code was in a separate repo, so thank you for letting me know.

For this particular case, I will ask you to add documentation directly in dotnet-api-docs, as in previous efforts. I will edit the description.

I will bring up the dotnet/wcf repo in our planning.