Skip to content

Commit d6d1333

Browse files
authored
style guide fixes - PR 4/8 (dotnet#1384)
* style guide fixes * Apply suggestions from PR review Co-Authored-By: mairaw <[email protected]> * feedback
1 parent 1a2c20d commit d6d1333

File tree

99 files changed

+225
-226
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+225
-226
lines changed

xml/System.Activities.Presentation.Model/Change.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@
8787
</ReturnValue>
8888
<Docs>
8989
<summary>When implemented in a derived class, gets a description of the change.</summary>
90-
<value>Returns a <see cref="T:System.String" /> that contains a description of the change.</value>
90+
<value>A string that contains a description of the change.</value>
9191
<remarks>To be added.</remarks>
9292
</Docs>
9393
</Member>
@@ -109,7 +109,7 @@
109109
<Parameters />
110110
<Docs>
111111
<summary>When implemented in a derived class, retrieves the inverse of the change.</summary>
112-
<returns>Returns a <see cref="T:System.Activities.Presentation.Model.Change" /> that contains the inverse of the current instance.</returns>
112+
<returns>The inverse of the current instance.</returns>
113113
<remarks>To be added.</remarks>
114114
</Docs>
115115
</Member>

xml/System.Activities.Presentation.Model/EditingScope.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
</ReturnValue>
7171
<Docs>
7272
<summary>Gets a list of changes.</summary>
73-
<value>Returns a <see cref="T:System.Collections.Generic.List`1" /> that contains the changes.</value>
73+
<value>A list of changes.</value>
7474
<remarks>To be added.</remarks>
7575
</Docs>
7676
</Member>

xml/System.Activities.Presentation.Model/ModelFactory.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
<param name="context">The designer's editing context.</param>
5151
<param name="item">The <see cref="T:System.Activities.Presentation.Model.ModelItem" /> to clone.</param>
5252
<summary>Creates a new <see cref="T:System.Activities.Presentation.Model.ModelItem" /> by creating a deep copy of the instance provided.</summary>
53-
<returns>Returns the newly created <see cref="T:System.Activities.Presentation.Model.ModelItem" />.</returns>
53+
<returns>The newly created <see cref="T:System.Activities.Presentation.Model.ModelItem" />.</returns>
5454
<remarks>To be added.</remarks>
5555
</Docs>
5656
</Member>
@@ -90,7 +90,7 @@
9090
<param name="itemType">The type of the <see cref="T:System.Activities.Presentation.Model.ModelItem" /> to create.</param>
9191
<param name="arguments">An optional array of arguments that should be passed to the constructor of the item.</param>
9292
<summary>Creates a new <see cref="T:System.Activities.Presentation.Model.ModelItem" /> for the given item type.</summary>
93-
<returns>Returns the newly created <see cref="T:System.Activities.Presentation.Model.ModelItem" />.</returns>
93+
<returns>The newly created <see cref="T:System.Activities.Presentation.Model.ModelItem" />.</returns>
9494
<remarks>To be added.</remarks>
9595
</Docs>
9696
</Member>
@@ -127,7 +127,7 @@
127127
<param name="options">A set of options used when creating the item.</param>
128128
<param name="arguments">An optional array of arguments that should be passed to the constructor of the item.</param>
129129
<summary>Creates a new <see cref="T:System.Activities.Presentation.Model.ModelItem" /> for the given item type.</summary>
130-
<returns>Returns the newly created <see cref="T:System.Activities.Presentation.Model.ModelItem" />.</returns>
130+
<returns>The newly created <see cref="T:System.Activities.Presentation.Model.ModelItem" />.</returns>
131131
<remarks>To be added.</remarks>
132132
</Docs>
133133
</Member>
@@ -155,7 +155,7 @@
155155
<param name="type">The type that contains the static member being referenced.</param>
156156
<param name="memberName">The name of the static member being referenced.</param>
157157
<summary>Creates a new <see cref="T:System.Activities.Presentation.Model.ModelItem" /> that represents the value of a static member of the given class.</summary>
158-
<returns>Returns the newly created <see cref="T:System.Activities.Presentation.Model.ModelItem" />.</returns>
158+
<returns>The newly created <see cref="T:System.Activities.Presentation.Model.ModelItem" />.</returns>
159159
<remarks>To be added.</remarks>
160160
</Docs>
161161
</Member>

xml/System.Activities.Presentation.Model/ModelItemCollection.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@
312312
</ReturnValue>
313313
<Docs>
314314
<summary>Returns the count of items in the collection.</summary>
315-
<value>Returns the <see cref="T:System.Int32" /> count of items in the collection.</value>
315+
<value>The count of items in the collection.</value>
316316
<remarks>
317317
<format type="text/markdown"><![CDATA[
318318
@@ -344,7 +344,7 @@
344344
<Parameters />
345345
<Docs>
346346
<summary>Gets an enumerator that iterates through the <see cref="T:System.Activities.Presentation.Model.ModelItemCollection" />.</summary>
347-
<returns>Returns an <see cref="T:System.Collections.Generic.IEnumerator`1" /> for the <see cref="T:System.Activities.Presentation.Model.ModelItemCollection" />.</returns>
347+
<returns>An enumerator for the <see cref="T:System.Activities.Presentation.Model.ModelItemCollection" />.</returns>
348348
<remarks>To be added.</remarks>
349349
</Docs>
350350
</Member>
@@ -723,7 +723,7 @@
723723
</ReturnValue>
724724
<Docs>
725725
<summary>Gets an object that can be used to synchronize access to the collection.</summary>
726-
<value>Returns an <see cref="T:System.Object" />.</value>
726+
<value>An object that can be used to synchronize access to the collection.</value>
727727
<remarks>To be added.</remarks>
728728
</Docs>
729729
</Member>
@@ -779,7 +779,7 @@
779779
</ReturnValue>
780780
<Docs>
781781
<summary>Gets the number of elements contained in the collection.</summary>
782-
<value>Returns an <see cref="T:System.Int32" /> value that is the number of elements contained in the collection.</value>
782+
<value>The number of elements contained in the collection.</value>
783783
<remarks>To be added.</remarks>
784784
</Docs>
785785
</Member>
@@ -838,7 +838,7 @@
838838
</ReturnValue>
839839
<Docs>
840840
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</summary>
841-
<value>Returns an <see cref="T:System.Object" /> that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
841+
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
842842
<remarks>To be added.</remarks>
843843
</Docs>
844844
</Member>
@@ -870,7 +870,7 @@
870870
<Parameters />
871871
<Docs>
872872
<summary>Returns an enumerator that iterates through a collection.</summary>
873-
<returns>Returns an <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.</returns>
873+
<returns>An enumerator that can be used to iterate through the collection.</returns>
874874
<remarks>To be added.</remarks>
875875
</Docs>
876876
</Member>
@@ -897,7 +897,7 @@
897897
<Docs>
898898
<param name="value">The object to add to the collection.</param>
899899
<summary>Adds a model item to the end of the <see cref="T:System.Activities.Presentation.Model.ModelItemCollection" />.</summary>
900-
<returns>Returns the index of the newly added object.</returns>
900+
<returns>The index of the newly added object.</returns>
901901
<remarks>To be added.</remarks>
902902
</Docs>
903903
</Member>
@@ -987,7 +987,7 @@
987987
<Docs>
988988
<param name="value">The <see cref="T:System.Object" /> to locate in the <see cref="T:System.Collections.IList" />.</param>
989989
<summary>Determines the index of a specific item in the <see cref="T:System.Collections.IList" />.</summary>
990-
<returns>Returns the <see cref="T:System.Int32" /> index of <paramref name="value" /> if found in the list; otherwise, -1.</returns>
990+
<returns>The index of <paramref name="value" /> if found in the list; otherwise, -1.</returns>
991991
<remarks>To be added.</remarks>
992992
</Docs>
993993
</Member>
@@ -1177,4 +1177,4 @@
11771177
</Docs>
11781178
</Member>
11791179
</Members>
1180-
</Type>
1180+
</Type>

xml/System.Activities.Presentation.Model/ModelItemDictionary.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@
133133
<param name="key">The key in the key/value pair to be added.</param>
134134
<param name="value">The value in the key/value pair to be added.</param>
135135
<summary>Adds the value to the dictionary under the given key. This method wraps the key and value in a set of <see cref="T:System.Activities.Presentation.Model.ModelItem" /> objects.</summary>
136-
<returns>Returns a <see cref="T:System.Activities.Presentation.Model.ModelItem" /> that represents the key.</returns>
136+
<returns>A <see cref="T:System.Activities.Presentation.Model.ModelItem" /> that represents the key.</returns>
137137
<remarks>To be added.</remarks>
138138
<exception cref="T:System.ArgumentNullException">If <paramref name="key" /> or <paramref name="value" /> is <see langword="null" />.</exception>
139139
<exception cref="T:System.InvalidOperationException">If the <see cref="T:System.Activities.Presentation.Model.ModelItemDictionary" /> is read-only.</exception>

xml/System.IdentityModel.Tokens/Saml2NameIdentifier.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@
113113
<ReturnType>System.IdentityModel.Tokens.EncryptingCredentials</ReturnType>
114114
</ReturnValue>
115115
<Docs>
116-
<summary>Get or sets the credentials used for encrypting the name identifier in an EncryptedID element.</summary>
116+
<summary>Gets or sets the credentials used for encrypting the name identifier in an EncryptedID element.</summary>
117117
<value>A <see cref="T:System.IdentityModel.Tokens.EncryptingCredentials" /> that represents the credentials used to encrypt the name identifier.</value>
118118
<remarks>To be added.</remarks>
119119
</Docs>

xml/System.IdentityModel.Tokens/Saml2SubjectConfirmationData.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@
117117
</ReturnValue>
118118
<Docs>
119119
<summary>Gets the collection of cryptographic keys that are used in some way to authenticate an attesting entity. [Saml2Core, 2.4.1.3]</summary>
120-
<value>Returns a collection of type <see cref="T:System.IdentityModel.Tokens.SecurityKeyIdentifier" /> that contains the keys.</value>
120+
<value>A collection of type <see cref="T:System.IdentityModel.Tokens.SecurityKeyIdentifier" /> that contains the keys.</value>
121121
<remarks>
122122
<format type="text/markdown"><![CDATA[
123123

xml/System.IdentityModel.Tokens/SamlAction.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@
164164
</ReturnValue>
165165
<Docs>
166166
<summary>Gets or sets the action that the subject of the <see cref="T:System.IdentityModel.Tokens.SamlAuthorizationDecisionStatement" /> can perform on the specified resource.</summary>
167-
<value>Gets or sets the action that the subject of the <see cref="T:System.IdentityModel.Tokens.SamlSecurityToken" /> security token seeks to perform on the specified resource.</value>
167+
<value>The action that the subject of the <see cref="T:System.IdentityModel.Tokens.SamlSecurityToken" /> security token seeks to perform on the specified resource.</value>
168168
<remarks>
169169
<format type="text/markdown"><![CDATA[
170170

xml/System.Linq.Expressions/BinaryExpression.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@
188188
</ReturnValue>
189189
<Docs>
190190
<summary>Gets a value that indicates whether the expression tree node can be reduced.</summary>
191-
<value>True if the expression tree node can be reduced, otherwise false.</value>
191+
<value><see langword="true" /> if the expression tree node can be reduced; otherwise, <see langword="false" />.</value>
192192
<remarks>To be added.</remarks>
193193
</Docs>
194194
</Member>

xml/System.Linq.Expressions/DebugInfoExpression.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@
218218
</ReturnValue>
219219
<Docs>
220220
<summary>Gets the value to indicate if the <see cref="T:System.Linq.Expressions.DebugInfoExpression" /> is for clearing a sequence point.</summary>
221-
<value>True if the <see cref="T:System.Linq.Expressions.DebugInfoExpression" /> is for clearing a sequence point, otherwise false.</value>
221+
<value><see langword="true" /> if the <see cref="T:System.Linq.Expressions.DebugInfoExpression" /> is for clearing a sequence point; otherwise, <see langword="false" />.</value>
222222
<remarks>To be added.</remarks>
223223
</Docs>
224224
</Member>

0 commit comments

Comments
 (0)