Skip to content

Commit 2e48a9d

Browse files
mairawmairaw
authored
Merge pull request #3450 from dotnet/master
Update live with current master
2 parents 93be473 + 33a6583 commit 2e48a9d

File tree

26 files changed

+409
-390
lines changed

26 files changed

+409
-390
lines changed

‎docfx.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
"ms.topic": "managed-reference",
5050
"ms.prod": "dotnet-api",
5151
"feedback_system": "None",
52+
"defaultDevLang": "csharp",
5253
"_op_documentIdPathDepotMapping": {
5354
"api/": {
5455
"depot_name": "VS.core-docs"

‎xml/System.Collections.Generic/CollectionExtensions.xml

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
</Base>
2020
<Interfaces />
2121
<Docs>
22-
<summary>To be added.</summary>
22+
<summary>Provides extension methods for generic collections.</summary>
2323
<remarks>To be added.</remarks>
2424
</Docs>
2525
<Members>
@@ -52,13 +52,14 @@
5252
<Parameter Name="key" Type="TKey" />
5353
</Parameters>
5454
<Docs>
55-
<typeparam name="TKey">To be added.</typeparam>
56-
<typeparam name="TValue">To be added.</typeparam>
57-
<param name="dictionary">To be added.</param>
58-
<param name="key">To be added.</param>
59-
<summary>To be added.</summary>
60-
<returns>To be added.</returns>
55+
<typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
56+
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
57+
<param name="dictionary">A dictionary with keys of type <typeparamref name="TKey" /> and values of type <typeparamref name="TValue" />.</param>
58+
<param name="key">The key of the value to get.</param>
59+
<summary>Tries to get the value associated with the specified <paramref name="key" /> in the <paramref name="dictionary" />.</summary>
60+
<returns>A <typeparamref name="TValue" /> instance. When the method is successful, the returned object is the value associated with the specified <paramref name="key" />. When the method fails, it returns the <see langword="default" /> value for <typeparamref name="TValue" />.</returns>
6161
<remarks>To be added.</remarks>
62+
<exception cref="T:System.ArgumentNullException"><paramref name="dictionary" /> is <see langword="null" />.</exception>
6263
</Docs>
6364
</Member>
6465
<Member MemberName="GetValueOrDefault&lt;TKey,TValue&gt;">
@@ -91,14 +92,15 @@
9192
<Parameter Name="defaultValue" Type="TValue" />
9293
</Parameters>
9394
<Docs>
94-
<typeparam name="TKey">To be added.</typeparam>
95-
<typeparam name="TValue">To be added.</typeparam>
96-
<param name="dictionary">To be added.</param>
97-
<param name="key">To be added.</param>
98-
<param name="defaultValue">To be added.</param>
99-
<summary>To be added.</summary>
100-
<returns>To be added.</returns>
95+
<typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
96+
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
97+
<param name="dictionary">A dictionary with keys of type <typeparamref name="TKey" /> and values of type <typeparamref name="TValue" />.</param>
98+
<param name="key">The key of the value to get.</param>
99+
<param name="defaultValue">The default value to return when the <paramref name="dictionary" /> cannot find a value associated with the specified <paramref name="key" />.</param>
100+
<summary>Tries to get the value associated with the specified key in the <paramref name="dictionary" />.</summary>
101+
<returns>A <typeparamref name="TValue" /> instance. When the method is successful, the returned object is the value associated with the specified <paramref name="key" />. When the method fails, it returns <paramref name="defaultValue" />.</returns>
101102
<remarks>To be added.</remarks>
103+
<exception cref="T:System.ArgumentNullException"><paramref name="dictionary" /> is <see langword="null" />.</exception>
102104
</Docs>
103105
</Member>
104106
<Member MemberName="Remove&lt;TKey,TValue&gt;">
@@ -131,14 +133,15 @@
131133
<Parameter Name="value" Type="TValue" RefType="out" />
132134
</Parameters>
133135
<Docs>
134-
<typeparam name="TKey">To be added.</typeparam>
135-
<typeparam name="TValue">To be added.</typeparam>
136-
<param name="dictionary">To be added.</param>
137-
<param name="key">To be added.</param>
138-
<param name="value">To be added.</param>
139-
<summary>To be added.</summary>
140-
<returns>To be added.</returns>
136+
<typeparam name="TKey">The type of the keys in the <paramref name="dictionary" />.</typeparam>
137+
<typeparam name="TValue">The type of the values in the <paramref name="dictionary" />.</typeparam>
138+
<param name="dictionary">A dictionary with keys of type <typeparamref name="TKey" /> and values of type <typeparamref name="TValue" />.</param>
139+
<param name="key">The key of the value to remove.</param>
140+
<param name="value">When this method returns <see langword="true" />, the removed value; when this method returns <see langword="false" />, the <see langword="default" /> value for <typeparamref name="TValue" />.</param>
141+
<summary>Tries to remove the value with the specified <paramref name="key" /> from the <paramref name="dictionary" />.</summary>
142+
<returns><see langword="true" /> when a value is found in the <paramref name="dictionary" /> with the specified <paramref name="key" />; <see langword="false" /> when the <paramref name="dictionary" /> cannot find a value associated with the specified <paramref name="key" />.</returns>
141143
<remarks>To be added.</remarks>
144+
<exception cref="T:System.ArgumentNullException"><paramref name="dictionary" /> is <see langword="null" />.</exception>
142145
</Docs>
143146
</Member>
144147
<Member MemberName="TryAdd&lt;TKey,TValue&gt;">
@@ -171,14 +174,15 @@
171174
<Parameter Name="value" Type="TValue" />
172175
</Parameters>
173176
<Docs>
174-
<typeparam name="TKey">To be added.</typeparam>
175-
<typeparam name="TValue">To be added.</typeparam>
176-
<param name="dictionary">To be added.</param>
177-
<param name="key">To be added.</param>
178-
<param name="value">To be added.</param>
179-
<summary>To be added.</summary>
180-
<returns>To be added.</returns>
177+
<typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
178+
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
179+
<param name="dictionary">A dictionary with keys of type <typeparamref name="TKey" /> and values of type <typeparamref name="TValue" />.</param>
180+
<param name="key">The key of the value to add.</param>
181+
<param name="value">The value to add.</param>
182+
<summary>Tries to add the specified <paramref name="key" /> and <paramref name="value" /> to the <paramref name="dictionary" />.</summary>
183+
<returns><see langword="true" /> when the <paramref name="key" /> and <paramref name="value" /> are successfully added to the <paramref name="dictionary" />; <see langword="false" /> when the <paramref name="dictionary" /> already contains the specified <paramref name="key" />, in which case nothing gets added.</returns>
181184
<remarks>To be added.</remarks>
185+
<exception cref="T:System.ArgumentNullException"><paramref name="dictionary" /> is <see langword="null" />.</exception>
182186
</Docs>
183187
</Member>
184188
</Members>

‎xml/System.Collections.ObjectModel/KeyedCollection`2.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1122,11 +1122,12 @@
11221122
<Parameter Name="item" Type="TItem" RefType="out" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
11231123
</Parameters>
11241124
<Docs>
1125-
<param name="key">To be added.</param>
1126-
<param name="item">To be added.</param>
1127-
<summary>To be added.</summary>
1128-
<returns>To be added.</returns>
1125+
<param name="key">The key of the item to search in the collection.</param>
1126+
<param name="item">When this method returns <see langword="true" />, the item from the collection that matches the provided key; when this method returns <see langword="false" />, the <see langword="default" /> value for the type of the collection.</param>
1127+
<summary>Tries to get an item from the collection using the specified key.</summary>
1128+
<returns><see langword="true" /> if an item for the specified key was found in the collection; otherwise, <see langword="false" />.</returns>
11291129
<remarks>To be added.</remarks>
1130+
<exception cref="T:System.ArgumentNullException"><paramref name="key" /> is <see langword="null" />.</exception>
11301131
</Docs>
11311132
</Member>
11321133
</Members>

‎xml/System.Data.Odbc/OdbcParameter.xml

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -746,9 +746,18 @@ public void CreateOdbcParameter()
746746
<ReturnType>System.Int32</ReturnType>
747747
</ReturnValue>
748748
<Docs>
749-
<summary>To be added.</summary>
750-
<value>To be added.</value>
751-
<remarks>To be added.</remarks>
749+
<summary>Gets or sets the offset of the data within the column.</summary>
750+
<value>The offset of the data within the column. The default value is zero.</value>
751+
<remarks>
752+
<format type="text/markdown"><![CDATA[
753+
754+
## Remarks
755+
The <xref:System.Data.Odbc.OdbcParameter.Offset> property is used for binary and string types. For fixed length data types, the value of <xref:System.Data.Odbc.OdbcParameter.Offset> is ignored.
756+
757+
For nonstring data types and ANSI string data, the <xref:System.Data.Odbc.OdbcParameter.Offset> property refers to the number of bytes. For Unicode string data, <xref:System.Data.Odbc.OdbcParameter.Offset> refers to the number of characters.
758+
759+
]]></format>
760+
</remarks>
752761
</Docs>
753762
</Member>
754763
<Member MemberName="ParameterName">

‎xml/System.Globalization/CharUnicodeInfo.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -666,9 +666,9 @@
666666
<Parameter Name="codePoint" Type="System.Int32" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
667667
</Parameters>
668668
<Docs>
669-
<param name="codePoint">To be added.</param>
670-
<summary>To be added.</summary>
671-
<returns>To be added.</returns>
669+
<param name="codePoint">A number representing the 32-bit code point value of the Unicode character.</param>
670+
<summary>Gets the Unicode category of the specified character.</summary>
671+
<returns>A <see cref="T:System.Globalization.UnicodeCategory" /> value indicating the category of the specified character.</returns>
672672
<remarks>To be added.</remarks>
673673
</Docs>
674674
</Member>

‎xml/System.Globalization/CultureInfo.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2911,7 +2911,7 @@ For a list of predefined culture names on Windows systems, see the **Language ta
29112911
</ReturnValue>
29122912
<Docs>
29132913
<summary>Gets the culture name in the format *languagecode2*-*country/regioncode2*.</summary>
2914-
<value>The culture name in the format *languagecode2*-*country/regioncode2*. *languagecode2* is a lowercase two-letter code derived from ISO 639-1. *country/regioncode2* is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag.</value>
2914+
<value>The culture name in the format *languagecode2*-*country/regioncode2*, if the current <see cref="T:System.Globalization.CultureInfo" /> is culture-dependent; or an empty string, if it's an invariant culture. *languagecode2* is a lowercase two-letter code derived from ISO 639-1. *country/regioncode2* is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag.</value>
29152915
<remarks>
29162916
<format type="text/markdown"><![CDATA[
29172917

‎xml/System.IO.Compression/BrotliDecoder.xml

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
</Interface>
2323
</Interfaces>
2424
<Docs>
25-
<summary>To be added.</summary>
25+
<summary>Provides non-allocating, performant Brotli decompression methods. The methods decompress in a single pass without using a <see cref="T:System.IO.Compression.Brotli.BrotliStream" /> instance.</summary>
2626
<remarks>To be added.</remarks>
2727
</Docs>
2828
<Members>
@@ -52,13 +52,25 @@
5252
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" />
5353
</Parameters>
5454
<Docs>
55-
<param name="source">To be added.</param>
56-
<param name="destination">To be added.</param>
57-
<param name="bytesConsumed">To be added.</param>
58-
<param name="bytesWritten">To be added.</param>
59-
<summary>To be added.</summary>
60-
<returns>To be added.</returns>
61-
<remarks>To be added.</remarks>
55+
<param name="source">A buffer containing the compressed data.</param>
56+
<param name="destination">When this method returns, a byte span containing the decompressed data.</param>
57+
<param name="bytesConsumed">The total number of bytes that were read from <paramref name="source" />.</param>
58+
<param name="bytesWritten">The total number of bytes that were written in the <paramref name="destination" />.</param>
59+
<summary>Decompresses data that was compressed using the Brotli algorithm.</summary>
60+
<returns>One of the enumeration values that indicates the status of the decompression operation.</returns>
61+
<remarks>
62+
<format type="text/markdown"><![CDATA[
63+
64+
## Remarks
65+
66+
The return value can be as follows:
67+
- <xref:System.Buffers.OperationStatus.Done?displayProperty=nameWithType>: `source` was successfully and completely decompressed into `destination`.
68+
- <xref:System.Buffers.OperationStatus.DestinationTooSmall?displayProperty=nameWithType>: There is not enough space in `destination` to decompress `source`.
69+
- <xref:System.Buffers.OperationStatus.NeedMoreData?displayProperty=nameWithType>: The decompression action is partially done at least one more byte is required to complete the decompression task. This method should be called again with more input to decompress.
70+
- <xref:System.Buffers.OperationStatus.InvalidData?displayProperty=nameWithType>: The data in `source` is invalid and could not be decompressed.
71+
72+
]]></format>
73+
</remarks>
6274
</Docs>
6375
</Member>
6476
<Member MemberName="Dispose">
@@ -85,7 +97,7 @@
8597
</ReturnValue>
8698
<Parameters />
8799
<Docs>
88-
<summary>To be added.</summary>
100+
<summary>Releases all resources used by the current Brotli decoder instance.</summary>
89101
<remarks>To be added.</remarks>
90102
</Docs>
91103
</Member>
@@ -114,12 +126,20 @@
114126
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" />
115127
</Parameters>
116128
<Docs>
117-
<param name="source">To be added.</param>
118-
<param name="destination">To be added.</param>
119-
<param name="bytesWritten">To be added.</param>
120-
<summary>To be added.</summary>
121-
<returns>To be added.</returns>
122-
<remarks>To be added.</remarks>
129+
<param name="source">A buffer containing the compressed data.</param>
130+
<param name="destination">When this method returns, a byte span containing the decompressed data.</param>
131+
<param name="bytesWritten">The total number of bytes that were written in the <paramref name="destination" />.</param>
132+
<summary>Attempts to decompress data that was compressed with the Brotli algorithm.</summary>
133+
<returns><see langword="true" /> on success; <see langword="false" /> otherwise.</returns>
134+
<remarks>
135+
<format type="text/markdown"><![CDATA[
136+
137+
## Remarks
138+
139+
If this method returns `false`, `destination` may be empty or contain partially decompressed data, with `bytesWritten` being zero or greater than zero but less than the expected total.
140+
141+
]]></format>
142+
</remarks>
123143
</Docs>
124144
</Member>
125145
</Members>

‎xml/System.IO.Enumeration/FileSystemEnumerable`1.xml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,17 @@
5454
<Parameter Name="options" Type="System.IO.EnumerationOptions" />
5555
</Parameters>
5656
<Docs>
57-
<param name="directory">To be added.</param>
58-
<param name="transform">To be added.</param>
59-
<param name="options">To be added.</param>
60-
<summary>To be added.</summary>
61-
<remarks>To be added.</remarks>
57+
<param name="directory">The path of the directory where the enumeration will be performed.</param>
58+
<param name="transform">A delegate method for transforming raw find data into a result.</param>
59+
<param name="options">An object describing the enumeration options.</param>
60+
<summary>Initializes a new instance of the <see cref="T:System.IO.Enumeration.FileSystemEnumerable`1" /> class with specific search and filtering options.</summary>
61+
<remarks>To be added.</remarks>
62+
<exception cref="T:System.ArgumentNullException"><paramref name="directory" /> or <paramref name="transform" /> is <see langword="null" />.</exception>
63+
<exception cref="T:System.ArgumentException">The <paramref name="directory" /> path is empty.
64+
65+
-or-
66+
67+
<paramref name="directory" /> contains a null character "\0".</exception>
6268
</Docs>
6369
</Member>
6470
<Member MemberName="GetEnumerator">

0 commit comments

Comments
 (0)