Skip to content

Commit 3de5667

Browse files
Copilotjeffhandley
andcommitted
Remove unnecessary para tags and fix XML formatting per detailed review feedback
Co-authored-by: jeffhandley <[email protected]>
1 parent 07c9e95 commit 3de5667

File tree

10 files changed

+73
-232
lines changed

10 files changed

+73
-232
lines changed

xml/System.Collections.Concurrent/ConcurrentDictionary`2+AlternateLookup`1.xml

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,8 @@
127127
<Docs>
128128
<param name="key">The alternate key of the value to get or set.</param>
129129
<summary>Gets or sets the value associated with the specified alternate key.</summary>
130-
<value>
131-
<para>The value associated with the specified alternate key. If the specified alternate key is not found, a get operation throws</para>
132-
<para>a <see cref="T:System.Collections.Generic.KeyNotFoundException" />, and a set operation creates a new element with the specified key.</para>
133-
</value>
130+
<value>The value associated with the specified alternate key. If the specified alternate key is not found, a get operation throws</para>
131+
<para>a <see cref="T:System.Collections.Generic.KeyNotFoundException" />, and a set operation creates a new element with the specified key.</value>
134132
<remarks>To be added.</remarks>
135133
<exception cref="T:System.ArgumentNullException">
136134
<paramref name="key" /> is <see langword="null" />.</exception>
@@ -197,10 +195,7 @@
197195
</Parameters>
198196
<Docs>
199197
<param name="key">The alternate key of the value to get.</param>
200-
<param name="value">
201-
<para>When this method returns, contains the value associated with the specified key, if the key is found;</para>
202-
<para>otherwise, the default value for the type of the value parameter.</para>
203-
</param>
198+
<param name="value">When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter.</param>
204199
<summary>Gets the value associated with the specified alternate key.</summary>
205200
<returns>
206201
<see langword="true" /> if an entry was found; otherwise, <see langword="false" />.</returns>
@@ -246,14 +241,9 @@
246241
</Parameters>
247242
<Docs>
248243
<param name="key">The alternate key of the value to get.</param>
249-
<param name="actualKey">
250-
<para>When this method returns, contains the actual key associated with the alternate key, if the key is found;</para>
251-
<para>otherwise, the default value for the type of the key parameter.</para>
252-
</param>
253-
<param name="value">
254-
<para>When this method returns, contains the value associated with the specified key, if the key is found;</para>
255-
<para>otherwise, the default value for the type of the value parameter.</para>
256-
</param>
244+
<param name="actualKey">When this method returns, contains the actual key associated with the alternate key, if the key is found;</para>
245+
<para>otherwise, the default value for the type of the key parameter.</param>
246+
<param name="value">When this method returns, contains the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter.</param>
257247
<summary>Gets the value associated with the specified alternate key.</summary>
258248
<returns>
259249
<see langword="true" /> if an entry was found; otherwise, <see langword="false" />.</returns>
@@ -292,10 +282,7 @@
292282
<Docs>
293283
<param name="key">The alternate key of the element to remove.</param>
294284
<param name="value">The removed element.</param>
295-
<summary>
296-
<para>Removes the value with the specified alternate key from the <see cref="T:System.Collections.Generic.Dictionary`2" />,</para>
297-
<para>and copies the element to the value parameter.</para>
298-
</summary>
285+
<summary>Removes the value with the specified alternate key from the <see cref="T:System.Collections.Generic.Dictionary`2" />, and copies the element to the value parameter.</summary>
299286
<returns>
300287
<see langword="true" /> if the element is successfully found and removed; otherwise, <see langword="false" />.</returns>
301288
<remarks>To be added.</remarks>
@@ -342,10 +329,8 @@
342329
<param name="key">The alternate key of the element to remove.</param>
343330
<param name="actualKey">The removed key.</param>
344331
<param name="value">The removed element.</param>
345-
<summary>
346-
<para>Removes the value with the specified alternate key from the <see cref="T:System.Collections.Generic.Dictionary`2" />,</para>
347-
<para>and copies the associated key and element to the value parameter.</para>
348-
</summary>
332+
<summary>Removes the value with the specified alternate key from the <see cref="T:System.Collections.Generic.Dictionary`2" />,</para>
333+
<para>and copies the associated key and element to the value parameter.</summary>
349334
<returns>
350335
<see langword="true" /> if the element is successfully found and removed; otherwise, <see langword="false" />.</returns>
351336
<remarks>To be added.</remarks>

xml/System.Collections.Concurrent/ConcurrentDictionary`2.xml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1014,11 +1014,9 @@
10141014
Gets an instance of a type that may be used to perform operations on a <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.
10151015
</summary>
10161016
<returns>The created lookup instance.</returns>
1017-
<remarks>
1018-
<para>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with</para>
1017+
<remarks>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with</para>
10191018
<para>
1020-
<typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />. If it doesn't, an exception will be thrown.</para>
1021-
</remarks>
1019+
<typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />. If it doesn't, an exception will be thrown.</remarks>
10221020
<exception cref="T:System.InvalidOperationException">This instance's comparer is not compatible with <typeparamref name="TAlternateKey" />.</exception>
10231021
</Docs>
10241022
</Member>

xml/System.Collections.Frozen/FrozenDictionary`2+AlternateLookup`1.xml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,8 @@
123123
<Docs>
124124
<param name="key">The alternate key of the value to get or set.</param>
125125
<summary>Gets or sets the value associated with the specified alternate key.</summary>
126-
<value>
127-
<para>The value associated with the specified alternate key. If the specified alternate key is not found, a get operation throws</para>
128-
<para>a <see cref="T:System.Collections.Generic.KeyNotFoundException" />, and a set operation creates a new element with the specified key.</para>
129-
</value>
126+
<value>The value associated with the specified alternate key. If the specified alternate key is not found, a get operation throws</para>
127+
<para>a <see cref="T:System.Collections.Generic.KeyNotFoundException" />, and a set operation creates a new element with the specified key.</value>
130128
<remarks>To be added.</remarks>
131129
<exception cref="T:System.ArgumentNullException">
132130
<paramref name="key" /> is <see langword="null" />.</exception>
@@ -162,10 +160,8 @@
162160
</Parameters>
163161
<Docs>
164162
<param name="key">The alternate key of the value to get.</param>
165-
<param name="value">
166-
<para>When this method returns, contains the value associated with the specified key, if the key is found;</para>
167-
<para>otherwise, the default value for the type of the value parameter.</para>
168-
</param>
163+
<param name="value">When this method returns, contains the value associated with the specified key, if the key is found;</para>
164+
<para>otherwise, the default value for the type of the value parameter.</param>
169165
<summary>Gets the value associated with the specified alternate key.</summary>
170166
<returns>
171167
<see langword="true" /> if an entry was found; otherwise, <see langword="false" />.</returns>

xml/System.Collections.Frozen/FrozenDictionary`2.xml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -294,11 +294,7 @@
294294
Gets an instance of a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenDictionary`2" /> using a <typeparamref name="TAlternateKey" /> as a key instead of a <typeparamref name="TKey" />.
295295
</summary>
296296
<returns>The created lookup instance.</returns>
297-
<remarks>
298-
<para>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with</para>
299-
<para>
300-
<typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />. If it doesn't, an exception will be thrown.</para>
301-
</remarks>
297+
<remarks>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with <typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />. If it doesn't, an exception will be thrown.</remarks>
302298
<exception cref="T:System.InvalidOperationException">This instance's comparer is not compatible with <typeparamref name="TAlternateKey" />.</exception>
303299
</Docs>
304300
</Member>

xml/System.Collections.Frozen/FrozenSet`1+AlternateLookup`1.xml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,7 @@
4848
<Docs>
4949
<typeparam name="T">The type of the values in this set.</typeparam>
5050
<typeparam name="TAlternate">The alternate type of a key for performing lookups.</typeparam>
51-
<summary>
52-
<para>Provides a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenSet`1" /> using a <typeparamref name="TAlternate" /> as a key instead of a <typeparamref name="T" />.</para>
53-
</summary>
51+
<summary>Provides a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenSet`1" /> using a <typeparamref name="TAlternate" /> as a key instead of a <typeparamref name="T" />.</summary>
5452
<remarks>To be added.</remarks>
5553
</Docs>
5654
<Members>

xml/System.Collections.Frozen/FrozenSet`1.xml

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -280,15 +280,9 @@
280280
<Parameters />
281281
<Docs>
282282
<typeparam name="TAlternate">The alternate type of a item for performing lookups.</typeparam>
283-
<summary>
284-
<para>Gets an instance of a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenSet`1" /> using a <typeparamref name="TAlternate" /> instead of a <typeparamref name="T" />.</para>
285-
</summary>
283+
<summary>Gets an instance of a type that may be used to perform operations on a <see cref="T:System.Collections.Frozen.FrozenSet`1" /> using a <typeparamref name="TAlternate" /> instead of a <typeparamref name="T" />.</summary>
286284
<returns>The created lookup instance.</returns>
287-
<remarks>
288-
<para>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with</para>
289-
<para>
290-
<typeparamref name="TAlternate" /> and <typeparamref name="T" />. If it doesn't, an exception will be thrown.</para>
291-
</remarks>
285+
<remarks>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with <typeparamref name="TAlternate" /> and <typeparamref name="T" />. If it doesn't, an exception will be thrown.</remarks>
292286
<exception cref="T:System.InvalidOperationException">This instance's comparer is not compatible with <typeparamref name="TAlternate" />.</exception>
293287
</Docs>
294288
</Member>

0 commit comments

Comments
 (0)