Skip to content

Commit 678a55a

Browse files
Copilotjeffhandley
andcommitted
Fix malformed XML with orphaned para tags and apply proper formatting guidelines
Co-authored-by: jeffhandley <[email protected]>
1 parent 3de5667 commit 678a55a

File tree

5 files changed

+40
-26
lines changed

5 files changed

+40
-26
lines changed

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

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,9 @@
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>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>
130+
<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.
132+
</value>
132133
<remarks>To be added.</remarks>
133134
<exception cref="T:System.ArgumentNullException">
134135
<paramref name="key" /> is <see langword="null" />.</exception>
@@ -241,9 +242,13 @@
241242
</Parameters>
242243
<Docs>
243244
<param name="key">The alternate key of the value to get.</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>
245+
<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.
248+
</param>
249+
<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.
251+
</param>
247252
<summary>Gets the value associated with the specified alternate key.</summary>
248253
<returns>
249254
<see langword="true" /> if an entry was found; otherwise, <see langword="false" />.</returns>
@@ -329,8 +334,10 @@
329334
<param name="key">The alternate key of the element to remove.</param>
330335
<param name="actualKey">The removed key.</param>
331336
<param name="value">The removed element.</param>
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>
337+
<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.
340+
</summary>
334341
<returns>
335342
<see langword="true" /> if the element is successfully found and removed; otherwise, <see langword="false" />.</returns>
336343
<remarks>To be added.</remarks>

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1014,9 +1014,10 @@
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>This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with</para>
1018-
<para>
1019-
<typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />. If it doesn't, an exception will be thrown.</remarks>
1017+
<remarks>
1018+
This instance must be using a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with
1019+
<typeparamref name="TAlternateKey" /> and <typeparamref name="TKey" />. If it doesn't, an exception will be thrown.
1020+
</remarks>
10201021
<exception cref="T:System.InvalidOperationException">This instance's comparer is not compatible with <typeparamref name="TAlternateKey" />.</exception>
10211022
</Docs>
10221023
</Member>

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

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,9 @@
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>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>
126+
<value>
127+
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.
128+
</value>
128129
<remarks>To be added.</remarks>
129130
<exception cref="T:System.ArgumentNullException">
130131
<paramref name="key" /> is <see langword="null" />.</exception>
@@ -160,8 +161,10 @@
160161
</Parameters>
161162
<Docs>
162163
<param name="key">The alternate key of the value to get.</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>
164+
<param name="value">
165+
When this method returns, contains the value associated with the specified key, if the key is found;
166+
otherwise, the default value for the type of the value parameter.
167+
</param>
165168
<summary>Gets the value associated with the specified alternate key.</summary>
166169
<returns>
167170
<see langword="true" /> if an entry was found; otherwise, <see langword="false" />.</returns>

xml/System.Text.Json.Serialization.Metadata/JsonParameterInfo.xml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,10 @@
5050
<Docs>
5151
<summary>Gets a custom attribute provider for the current parameter.</summary>
5252
<value>To be added.</value>
53-
<remarks>When resolving metadata via the built-in resolvers this will be populated with</para>
54-
<para>the underlying <see cref="T:System.Reflection.ParameterInfo" /> of the constructor metadata.</remarks>
53+
<remarks>
54+
When resolving metadata via the built-in resolvers this will be populated with
55+
the underlying <see cref="T:System.Reflection.ParameterInfo" /> of the constructor metadata.
56+
</remarks>
5557
</Docs>
5658
</Member>
5759
<Member MemberName="DeclaringType">
@@ -145,8 +147,10 @@
145147
<Docs>
146148
<summary>Gets a value indicating whether the parameter represents a required or init-only member initializer.</summary>
147149
<value>To be added.</value>
148-
<remarks>Only returns <see langword="true" /> for source-generated metadata that can only access</para>
149-
<para>required or init-only member initializers using object initialize expressions.</remarks>
150+
<remarks>
151+
Only returns <see langword="true" /> for source-generated metadata that can only access
152+
required or init-only member initializers using object initialize expressions.
153+
</remarks>
150154
</Docs>
151155
</Member>
152156
<Member MemberName="IsNullable">

xml/System.Text.Json/JsonSerializer.xml

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -381,14 +381,13 @@ There is remaining data in the string beyond a single JSON value.</exception>
381381
<param name="jsonTypeInfo">Metadata about the type to convert.</param>
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>
384-
<remarks>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.
385-
</para>
386-
<para> 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-
</para>
388-
<para> 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.
389-
</para>
390-
<para> 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.
391-
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.</remarks>
384+
<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.
390+
</remarks>
392391
<exception cref="T:System.Text.Json.JsonException">The JSON is invalid,
393392
<paramref name="jsonTypeInfo" /> is not compatible with the JSON,
394393
or a value could not be read from the reader.</exception>

0 commit comments

Comments
 (0)