Skip to content

Update documentation for SerializationSurrogateProvider property #3748

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 28, 2020
Merged

Update documentation for SerializationSurrogateProvider property #3748

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
13b6e9a
Update documentation for SerializationSurrogateProvider property
mconnew Jan 8, 2020
1521aba
Update xml/System.ServiceModel.Description/DataContractSerializerOper…
mconnew Jan 8, 2020
e6cc80a
feedback
mairaw Jan 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions xml/System.ServiceModel.Description/DataContractSerializerOperationBehavior.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
]]></format>
</remarks>
<altmember cref="T:System.Runtime.Serialization.IDataContractSurrogate" />
<altmember cref="T:System.Runtime.Serialization.ISerializationSurrogateProvider" />
<altmember cref="T:System.Runtime.Serialization.DataContractSerializer" />
<related type="Article" href="https://msdn.microsoft.com/library/8c31134c-46c5-4ed7-94af-bab0ac0dfce5">Data Contract Surrogates</related>
<related type="Article" href="~/docs/framework/wcf/feature-details/using-data-contracts.md">Using Data Contracts</related>
Expand Down Expand Up @@ -471,8 +472,8 @@
<ReturnType>System.Runtime.Serialization.ISerializationSurrogateProvider</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets a surrogate provider to be used during the serialization and deserialization processes.</summary>
<value>An <see cref="T:System.Runtime.Serialization.ISerializationSurrogateProvider" /> that is used to provide a serialization surrogate used during serialization and deserialization.</value>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that the type is automatically shown (https://review.docs.microsoft.com/en-us/dotnet/api/System.ServiceModel.Description.DataContractSerializerOperationBehavior.SerializationSurrogateProvider?branch=pr-en-us-3748&view=dotnet-plat-ext-3.1#property-value), I think you can have the plain text here too

Suggested change
<value>An <see cref="T:System.Runtime.Serialization.ISerializationSurrogateProvider" /> that is used to provide a serialization surrogate used during serialization and deserialization.</value>
<value>A surrogate provider that is used to provide a serialization surrogate to be used during serialization and deserialization.</value>

<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down