Skip to content

Commit

Permalink
Minor updates (#10547)
Browse files Browse the repository at this point in the history
* System.Collections.Concurrent

* System.Collections.Generic

* System.IO.Compression
  • Loading branch information
carlossanlop authored Oct 11, 2024
1 parent 6fc2cda commit 573b097
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 9 deletions.
4 changes: 2 additions & 2 deletions xml/System.Collections.Concurrent/ConcurrentDictionary`2.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1416,7 +1416,7 @@
<Docs>
<summary>Gets a collection containing the keys in the <see cref="T:System.Collections.Generic.Dictionary`2" />.</summary>
<value>A collection of keys in the <see cref="T:System.Collections.Generic.Dictionary`2" />.</value>
<remarks>To be added.</remarks>
<remarks>The property returns a copy of all the keys. It's not kept in sync with <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</remarks>
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
<related type="Article" href="/dotnet/standard/collections/thread-safe/how-to-add-and-remove-items">How to: Add and Remove Items from a ConcurrentDictionary</related>
</Docs>
Expand Down Expand Up @@ -3003,7 +3003,7 @@ The key is compared using the dictionary's comparer (or the default comparer for
<Docs>
<summary>Gets a collection that contains the values in the <see cref="T:System.Collections.Generic.Dictionary`2" />.</summary>
<value>A collection that contains the values in the <see cref="T:System.Collections.Generic.Dictionary`2" />.</value>
<remarks>To be added.</remarks>
<remarks>The property returns a copy of all the values. It's not kept in sync with <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</remarks>
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
<related type="Article" href="/dotnet/standard/collections/thread-safe/how-to-add-and-remove-items">How to: Add and Remove Items from a ConcurrentDictionary</related>
</Docs>
Expand Down
12 changes: 7 additions & 5 deletions xml/System.Collections.Generic/HashSet`1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1310,9 +1310,10 @@ The following example demonstrates how to merge two disparate sets. This example
<Parameters />
<Docs>
<typeparam name="TAlternate">The alternate type of instance for performing lookups.</typeparam>
<summary>Gets an instance of a type that can be used to perform operations on the current <see cref="T:System.Collections.Generic.HashSet`1"/> using a <typeparamref name="TAlternate"/> instead of a <typeparamref name="T"/>.</summary>
<summary>Gets an instance of a type that can be used to perform operations on the current <see cref="T:System.Collections.Generic.HashSet`1" /> using a <typeparamref name="TAlternate" /> instead of a <typeparamref name="T" />.</summary>
<returns>The created lookup instance.</returns>
<remarks>The set must use 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 is thrown.</remarks>
<remarks>The set must use 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 is thrown.</remarks>
<exception cref="T:System.InvalidOperationException">The set's comparer is not compatible with <typeparamref name="TAlternate" />.</exception>
</Docs>
</Member>
<Member MemberName="GetEnumerator">
Expand Down Expand Up @@ -2625,9 +2626,10 @@ The following example demonstrates how to merge two disparate sets. This example
<Docs>
<typeparam name="TAlternate">The alternate type of instance for performing lookups.</typeparam>
<param name="lookup">The created lookup instance when the method returns true, or a default instance that should not be used if the method returns false.</param>
<summary>Gets an instance of a type that can be used to perform operations on the current <see cref="T:System.Collections.Generic.HashSet`1"/> using a <typeparamref name="TAlternate"/> instead of a <typeparamref name="T"/>.</summary>
<returns><see langword="true" /> if a lookup could be created; otherwise, <see langword="false" />.</returns>
<remarks>The set must use a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2"/> with <typeparamref name="TAlternate"/> and <typeparamref name="T"/>. If it doesn't, the method returns <see langword="false" />.</remarks>
<summary>Gets an instance of a type that can be used to perform operations on the current <see cref="T:System.Collections.Generic.HashSet`1" /> using a <typeparamref name="TAlternate" /> instead of a <typeparamref name="T" />.</summary>
<returns>
<see langword="true" /> if a lookup could be created; otherwise, <see langword="false" />.</returns>
<remarks>The set must use a comparer that implements <see cref="T:System.Collections.Generic.IAlternateEqualityComparer`2" /> with <typeparamref name="TAlternate" /> and <typeparamref name="T" />. If it doesn't, the method returns <see langword="false" />.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetValue">
Expand Down
1 change: 1 addition & 0 deletions xml/System.Collections.Generic/Stack`1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1232,6 +1232,7 @@
]]></format>
</remarks>
<altmember cref="P:System.Collections.ICollection.SyncRoot" />
<inheritdoc cref="T:System.Collections.Generic.ICollection`1" />
</Docs>
</Member>
<Member MemberName="System.Collections.ICollection.SyncRoot">
Expand Down
2 changes: 1 addition & 1 deletion xml/System.IO.Compression/BrotliCompressionOptions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a <see cref="T:System.IO.Compression.BrotliCompressionOptions" /> instance with default values.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.IO.Compression/ZLibCompressionOptions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a <see cref="T:System.IO.Compression.ZLibCompressionOptions" /> instance with default values.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down

0 comments on commit 573b097

Please sign in to comment.