Skip to content

Commit e21a9b8

Browse files
Copilotjeffhandley
andcommitted
Fix XML formatting: use 2-space indentation, add line breaks for long content, and add para tags for semantic paragraphs
Co-authored-by: jeffhandley <[email protected]>
1 parent 678a55a commit e21a9b8

File tree

4 files changed

+45
-14
lines changed

4 files changed

+45
-14
lines changed

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

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@
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>
130130
<value>
131-
The value associated with the specified alternate key. If the specified alternate key is not found, a get operation throws a <see cref="T:System.Collections.Generic.KeyNotFoundException" />, and a set operation creates a new element with the specified key.
131+
The value associated with the specified alternate key. If the specified alternate key is not found, a get operation throws a <see cref="T:System.Collections.Generic.KeyNotFoundException" />, and a set operation creates a new element with the specified key.
132132
</value>
133133
<remarks>To be added.</remarks>
134134
<exception cref="T:System.ArgumentNullException">
@@ -243,11 +243,11 @@
243243
<Docs>
244244
<param name="key">The alternate key of the value to get.</param>
245245
<param name="actualKey">
246-
When this method returns, contains the actual key associated with the alternate key, if the key is found;
247-
otherwise, the default value for the type of the key parameter.
246+
When this method returns, contains the actual key associated with the alternate key, if the key is found;
247+
otherwise, the default value for the type of the key parameter.
248248
</param>
249249
<param name="value">
250-
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.
250+
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.
251251
</param>
252252
<summary>Gets the value associated with the specified alternate key.</summary>
253253
<returns>
@@ -287,7 +287,11 @@
287287
<Docs>
288288
<param name="key">The alternate key of the element to remove.</param>
289289
<param name="value">The removed element.</param>
290-
<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>
290+
<summary>
291+
Removes the value with the specified alternate key from the
292+
<see cref="T:System.Collections.Generic.Dictionary`2" />,
293+
and copies the element to the value parameter.
294+
</summary>
291295
<returns>
292296
<see langword="true" /> if the element is successfully found and removed; otherwise, <see langword="false" />.</returns>
293297
<remarks>To be added.</remarks>
@@ -335,8 +339,8 @@
335339
<param name="actualKey">The removed key.</param>
336340
<param name="value">The removed element.</param>
337341
<summary>
338-
Removes the value with the specified alternate key from the <see cref="T:System.Collections.Generic.Dictionary`2" />,
339-
and copies the associated key and element to the value parameter.
342+
Removes the value with the specified alternate key from the <see cref="T:System.Collections.Generic.Dictionary`2" />,
343+
and copies the associated key and element to the value parameter.
340344
</summary>
341345
<returns>
342346
<see langword="true" /> if the element is successfully found and removed; otherwise, <see langword="false" />.</returns>

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,10 @@
4545
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
4646
<typeparam name="TAlternateKey">The alternate type of a key for performing lookups.</typeparam>
4747
<summary>
48-
Provides 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" />.
48+
Provides a type that may be used to perform operations on a
49+
<see cref="T:System.Collections.Frozen.FrozenDictionary`2" />
50+
using a <typeparamref name="TAlternateKey" /> as a key
51+
instead of a <typeparamref name="TKey" />.
4952
</summary>
5053
<remarks>To be added.</remarks>
5154
</Docs>

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,12 @@
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>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>
297+
<remarks>
298+
This instance must be using a comparer that implements
299+
<see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" />
300+
with <typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />.
301+
If it doesn't, an exception will be thrown.
302+
</remarks>
298303
<exception cref="T:System.InvalidOperationException">This instance's comparer is not compatible with <typeparamref name="TAlternateKey" />.</exception>
299304
</Docs>
300305
</Member>

xml/System.Text.Json/JsonSerializer.xml

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -382,11 +382,30 @@ There is remaining data in the string beyond a single JSON value.</exception>
382382
<summary>Reads one JSON value (including objects or arrays) from the provided reader into an instance specified by the <paramref name="jsonTypeInfo" />.</summary>
383383
<returns>A <paramref name="jsonTypeInfo" /> representation of the JSON value.</returns>
384384
<remarks>
385-
If the <see cref="P:System.Text.Json.Utf8JsonReader.TokenType" /> property of <paramref name="reader" /> is <see cref="F:System.Text.Json.JsonTokenType.PropertyName" /> or <see cref="F:System.Text.Json.JsonTokenType.None" />, the reader will be advanced by one call to <see cref="M:System.Text.Json.Utf8JsonReader.Read" /> to determine the start of the value.
386-
Upon completion of this method, <paramref name="reader" /> will be positioned at the final token in the JSON value. If an exception is thrown, the reader is reset to the state it was in when the method was called.
387-
This method makes a copy of the data the reader acted on, so there is no caller requirement to maintain data integrity beyond the return of this method.
388-
The <see cref="T:System.Text.Json.JsonReaderOptions" /> used to create the instance of the <see cref="T:System.Text.Json.Utf8JsonReader" /> take precedence over the <see cref="T:System.Text.Json.JsonSerializerOptions" /> when they conflict.
389-
Hence, <see cref="P:System.Text.Json.JsonReaderOptions.AllowTrailingCommas" />, <see cref="P:System.Text.Json.JsonReaderOptions.MaxDepth" />, and <see cref="P:System.Text.Json.JsonReaderOptions.CommentHandling" /> are used while reading.
385+
<para>
386+
If the <see cref="P:System.Text.Json.Utf8JsonReader.TokenType" /> property of
387+
<paramref name="reader" /> is <see cref="F:System.Text.Json.JsonTokenType.PropertyName" />
388+
or <see cref="F:System.Text.Json.JsonTokenType.None" />, the reader will be advanced by one
389+
call to <see cref="M:System.Text.Json.Utf8JsonReader.Read" /> to determine the start of the value.
390+
</para>
391+
<para>
392+
Upon completion of this method, <paramref name="reader" /> will be positioned at the final token
393+
in the JSON value. If an exception is thrown, the reader is reset to the state it was in when the
394+
method was called.
395+
</para>
396+
<para>
397+
This method makes a copy of the data the reader acted on, so there is no caller requirement to
398+
maintain data integrity beyond the return of this method.
399+
</para>
400+
<para>
401+
The <see cref="T:System.Text.Json.JsonReaderOptions" /> used to create the instance of the
402+
<see cref="T:System.Text.Json.Utf8JsonReader" /> take precedence over the
403+
<see cref="T:System.Text.Json.JsonSerializerOptions" /> when they conflict.
404+
Hence, <see cref="P:System.Text.Json.JsonReaderOptions.AllowTrailingCommas" />,
405+
<see cref="P:System.Text.Json.JsonReaderOptions.MaxDepth" />, and
406+
<see cref="P:System.Text.Json.JsonReaderOptions.CommentHandling" /> are used
407+
while reading.
408+
</para>
390409
</remarks>
391410
<exception cref="T:System.Text.Json.JsonException">The JSON is invalid,
392411
<paramref name="jsonTypeInfo" /> is not compatible with the JSON,

0 commit comments

Comments
 (0)