Skip to content

Commit eb604f8

Browse files
Port documentation for .NET 7.0 Preview2 (#7889)
* Microsoft.Extensions.DiagnosticAdapter.Internal * Microsoft.Extensions.Logging.AzureAppServices.Internal * Microsoft.Extensions.Logging.Console * Microsoft.Extensions.Logging.Filter.Internal * Microsoft.Extensions.Logging.TraceSource * Microsoft.Extensions.Primitives * System * System.Collections.Concurrent * System.Collections.Immutable * System.Collections.Specialized * System.ComponentModel.Composition.ReflectionModel * System.ComponentModel.Design.Serialization * System.Data.SqlTypes * System.Diagnostics * System.Diagnostics.CodeAnalysis * System.Diagnostics.Metrics * System.Drawing * System.IO * System.IO.Compression * System.Linq * System.Net.Sockets * System.Reflection * System.Runtime.CompilerServices * System.Runtime.InteropServices * System.Runtime.Intrinsics.Arm * System.Security.Cryptography * System.Security.Cryptography.Cose * System.Text.RegularExpressions * System.Transactions * System.Web.DynamicData * Suggestions by gewarren Co-authored-by: Genevieve Warren <[email protected]> * suggestions by gewarren Co-authored-by: Genevieve Warren <[email protected]> * Apply suggestions from code review * Update xml/System.Diagnostics.Metrics/ObservableUpDownCounter`1.xml Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
1 parent 8fef544 commit eb604f8

File tree

69 files changed

+1506
-784
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+1506
-784
lines changed

xml/Microsoft.Extensions.DiagnosticAdapter.Internal/ProxyBase.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@
111111
</TypeParameters>
112112
<Parameters />
113113
<Docs>
114-
<typeparam name="T">To be added.</typeparam>
114+
<typeparam name="T">The type of the underlying object.</typeparam>
115115
<summary>Unwraps the underlying object and performs a cast to <typeparamref name="T" />.</summary>
116116
<returns>The underlying object.</returns>
117117
<remarks>To be added.</remarks>

xml/Microsoft.Extensions.DiagnosticAdapter.Internal/ProxyFactory.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
<Parameter Name="obj" Type="System.Object" />
8383
</Parameters>
8484
<Docs>
85-
<typeparam name="TProxy">To be added.</typeparam>
85+
<typeparam name="TProxy">The type of the proxy to create.</typeparam>
8686
<param name="obj">The object to wrap in a proxy.</param>
8787
<summary>Creates a proxy object that is assignable to type <typeparamref name="TProxy" />.</summary>
8888
<returns>A proxy object, or <paramref name="obj" /> if a proxy is not needed.</returns>

xml/Microsoft.Extensions.Logging.AzureAppServices.Internal/BatchingLogger.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@
7676
<Parameter Name="state" Type="TState" />
7777
</Parameters>
7878
<Docs>
79-
<typeparam name="TState">To be added.</typeparam>
79+
<typeparam name="TState">The type of the state to begin scope for.</typeparam>
8080
<param name="state">The identifier for the scope.</param>
8181
<summary>Begins a logical operation scope.</summary>
8282
<returns>A disposable object that ends the logical operation scope on dispose.</returns>

xml/Microsoft.Extensions.Logging.Console/ConsoleLogger.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116
<Parameter Name="state" Type="TState" />
117117
</Parameters>
118118
<Docs>
119-
<typeparam name="TState">To be added.</typeparam>
119+
<typeparam name="TState">The type of the state to begin scope for.</typeparam>
120120
<param name="state">The identifier for the scope.</param>
121121
<summary>Begins a logical operation scope.</summary>
122122
<returns>A disposable object that ends the logical operation scope on dispose.</returns>

xml/Microsoft.Extensions.Logging.Filter.Internal/FilterLogger.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
<Parameter Name="state" Type="TState" />
7676
</Parameters>
7777
<Docs>
78-
<typeparam name="TState">To be added.</typeparam>
78+
<typeparam name="TState">The type of the state to begin scope for.</typeparam>
7979
<param name="state">The identifier for the scope.</param>
8080
<summary>Begins a logical operation scope.</summary>
8181
<returns>An <see cref="T:System.IDisposable" /> that ends the logical operation scope on dispose.</returns>

xml/Microsoft.Extensions.Logging.TraceSource/TraceSourceLogger.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@
8686
<Parameter Name="state" Type="TState" />
8787
</Parameters>
8888
<Docs>
89-
<typeparam name="TState">To be added.</typeparam>
89+
<typeparam name="TState">The type of the state to begin scope for.</typeparam>
9090
<param name="state">The identifier for the scope.</param>
9191
<summary>Begins a logical operation scope.</summary>
9292
<returns>A disposable object that ends the logical operation scope on dispose.</returns>

xml/Microsoft.Extensions.Primitives/StringSegment.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -442,11 +442,11 @@
442442
</Parameter>
443443
</Parameters>
444444
<Docs>
445-
<param name="obj">To be added.</param>
445+
<param name="obj">An object to compare with this object.</param>
446446
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
447-
<returns>To be added.</returns>
447+
<returns>
448+
<see langword="true" /> if the current object is equal to <paramref name="obj" />; otherwise, <see langword="false" />.</returns>
448449
<remarks>To be added.</remarks>
449-
<inheritdoc />
450450
</Docs>
451451
</Member>
452452
<Member MemberName="Equals">

xml/System.Collections.Concurrent/BlockingCollection`1.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1404,6 +1404,7 @@ This member is an explicit interface member implementation. It can be used only
14041404
</remarks>
14051405
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
14061406
<exception cref="T:System.InvalidOperationException">The underlying collection was modified outside of this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance, or the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> is empty and the collection has been marked as complete for adding.</exception>
1407+
<exception cref="T:System.OperationCanceledException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> is empty and has been marked as complete with regards to additions.</exception>
14071408
<related type="Article" href="/dotnet/standard/collections/thread-safe/">Thread-Safe Collections</related>
14081409
<related type="Article" href="/dotnet/standard/collections/thread-safe/blockingcollection-overview">BlockingCollection Overview</related>
14091410
</Docs>

xml/System.Collections.Immutable/ImmutableArray.xml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -289,10 +289,10 @@
289289
<Parameter Name="items" Type="System.ReadOnlySpan&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" />
290290
</Parameters>
291291
<Docs>
292-
<typeparam name="T">To be added.</typeparam>
293-
<param name="items">To be added.</param>
294-
<summary>To be added.</summary>
295-
<returns>To be added.</returns>
292+
<typeparam name="T">The type of element stored in the array.</typeparam>
293+
<param name="items">The elements to store in the array.</param>
294+
<summary>Creates an <see cref="T:System.Collections.Immutable.ImmutableArray`1" /> with the specified elements.</summary>
295+
<returns>An immutable array containing the specified items.</returns>
296296
<remarks>To be added.</remarks>
297297
</Docs>
298298
</Member>
@@ -318,10 +318,10 @@
318318
<Parameter Name="items" Type="System.Span&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" />
319319
</Parameters>
320320
<Docs>
321-
<typeparam name="T">To be added.</typeparam>
322-
<param name="items">To be added.</param>
323-
<summary>To be added.</summary>
324-
<returns>To be added.</returns>
321+
<typeparam name="T">The type of element stored in the array.</typeparam>
322+
<param name="items">The elements to store in the array.</param>
323+
<summary>Creates an <see cref="T:System.Collections.Immutable.ImmutableArray`1" /> with the specified elements.</summary>
324+
<returns>An immutable array containing the specified items.</returns>
325325
<remarks>To be added.</remarks>
326326
</Docs>
327327
</Member>
@@ -976,10 +976,10 @@ This overload allows helper methods or custom builder classes to efficiently avo
976976
<Parameter Name="items" Type="System.ReadOnlySpan&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" RefType="this" />
977977
</Parameters>
978978
<Docs>
979-
<typeparam name="T">To be added.</typeparam>
980-
<param name="items">To be added.</param>
981-
<summary>To be added.</summary>
982-
<returns>To be added.</returns>
979+
<typeparam name="T">The type of element in the list.</typeparam>
980+
<param name="items">The elements to store in the array.</param>
981+
<summary>Produce an immutable array of contents from specified elements.</summary>
982+
<returns>An immutable array containing the items in the span.</returns>
983983
<remarks>To be added.</remarks>
984984
</Docs>
985985
</Member>
@@ -1005,10 +1005,10 @@ This overload allows helper methods or custom builder classes to efficiently avo
10051005
<Parameter Name="items" Type="System.Span&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" RefType="this" />
10061006
</Parameters>
10071007
<Docs>
1008-
<typeparam name="T">To be added.</typeparam>
1009-
<param name="items">To be added.</param>
1010-
<summary>To be added.</summary>
1011-
<returns>To be added.</returns>
1008+
<typeparam name="T">The type of element in the list.</typeparam>
1009+
<param name="items">The elements to store in the array.</param>
1010+
<summary>Converts the span to an immutable array.</summary>
1011+
<returns>An immutable array containing the items in the span.</returns>
10121012
<remarks>To be added.</remarks>
10131013
</Docs>
10141014
</Member>

xml/System.Collections.Immutable/ImmutableArray`1+Builder.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -216,8 +216,8 @@
216216
<Parameter Name="items" Type="System.ReadOnlySpan&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" />
217217
</Parameters>
218218
<Docs>
219-
<param name="items">To be added.</param>
220-
<summary>To be added.</summary>
219+
<param name="items">The items to add at the end of the array.</param>
220+
<summary>Adds the specified items to the end of the array.</summary>
221221
<remarks>To be added.</remarks>
222222
</Docs>
223223
</Member>
@@ -440,8 +440,8 @@
440440
</Parameters>
441441
<Docs>
442442
<typeparam name="TDerived">To be added.</typeparam>
443-
<param name="items">To be added.</param>
444-
<summary>To be added.</summary>
443+
<param name="items">The items to add at the end of the array.</param>
444+
<summary>Adds the specified items to the end of the array.</summary>
445445
<remarks>To be added.</remarks>
446446
</Docs>
447447
</Member>
@@ -606,8 +606,8 @@
606606
<Parameter Name="destination" Type="System.Span&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" />
607607
</Parameters>
608608
<Docs>
609-
<param name="destination">To be added.</param>
610-
<summary>To be added.</summary>
609+
<param name="destination">The <see cref="T:System.Span`1" /> to copy to.</param>
610+
<summary>Copies the current contents to the specified <see cref="T:System.Span`1" />.</summary>
611611
<remarks>To be added.</remarks>
612612
</Docs>
613613
</Member>

0 commit comments

Comments
 (0)