Skip to content

Commit ae69a2f

Browse files
Port System.Runtime.CompilerServices new docs (#10153)
* System.Runtime.CompilerServices --------- Co-authored-by: Genevieve Warren <[email protected]>
1 parent e58c2ef commit ae69a2f

9 files changed

+24
-16
lines changed

xml/System.Runtime.CompilerServices/CallConvSwift.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Indicates that a method should using the <see href="https://github.com/apple/swift/blob/main/docs/ABIStabilityManifesto.md#calling-convention">Swift</see> calling convention.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -31,7 +31,7 @@
3131
</AssemblyInfo>
3232
<Parameters />
3333
<Docs>
34-
<summary>To be added.</summary>
34+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CallConvSwift" /> class.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
</Member>

xml/System.Runtime.CompilerServices/ConfiguredTaskAwaitable+ConfiguredTaskAwaiter.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@
134134
<exception cref="T:System.NullReferenceException">The awaiter was not properly initialized.</exception>
135135
<exception cref="T:System.OperationCanceledException">The task was canceled.</exception>
136136
<exception cref="T:System.Exception">The task completed in a faulted state.</exception>
137+
<exception cref="T:System.Threading.Tasks.TaskCanceledException">The task was canceled.</exception>
137138
</Docs>
138139
</Member>
139140
<Member MemberName="IsCompleted">

xml/System.Runtime.CompilerServices/ConfiguredTaskAwaitable`1+ConfiguredTaskAwaiter.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@
149149
<exception cref="T:System.NullReferenceException">The awaiter was not properly initialized.</exception>
150150
<exception cref="T:System.OperationCanceledException">The task was canceled.</exception>
151151
<exception cref="T:System.Exception">The task completed in a faulted state.</exception>
152+
<exception cref="T:System.Threading.Tasks.TaskCanceledException">The task was canceled.</exception>
152153
</Docs>
153154
</Member>
154155
<Member MemberName="IsCompleted">

xml/System.Runtime.CompilerServices/OverloadResolutionPriorityAttribute.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>Specifies the priority of a member in overload resolution. When unspecified, the default priority is 0.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -40,8 +40,8 @@
4040
<Parameter Name="priority" Type="System.Int32" />
4141
</Parameters>
4242
<Docs>
43-
<param name="priority">To be added.</param>
44-
<summary>To be added.</summary>
43+
<param name="priority">The priority of the attributed member. Higher numbers are prioritized, lower numbers are deprioritized. 0 is the default if no attribute is present.</param>
44+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.OverloadResolutionPriorityAttribute" /> class.</summary>
4545
<remarks>To be added.</remarks>
4646
</Docs>
4747
</Member>
@@ -61,7 +61,7 @@
6161
<ReturnType>System.Int32</ReturnType>
6262
</ReturnValue>
6363
<Docs>
64-
<summary>To be added.</summary>
64+
<summary>The priority of the member.</summary>
6565
<value>To be added.</value>
6666
<remarks>To be added.</remarks>
6767
</Docs>

xml/System.Runtime.CompilerServices/ParamCollectionAttribute.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>Indicates that a method allows a variable number of arguments in its invocation.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>

xml/System.Runtime.CompilerServices/RuntimeFeature.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
<ReturnType>System.String</ReturnType>
9898
</ReturnValue>
9999
<Docs>
100-
<summary>To be added.</summary>
100+
<summary>Represents a runtime feature where byref-like types can be used in generic parameters.</summary>
101101
<remarks>To be added.</remarks>
102102
</Docs>
103103
</Member>

xml/System.Runtime.CompilerServices/RuntimeHelpers.xml

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -147,11 +147,14 @@
147147
<Parameter Name="type" Type="System.RuntimeTypeHandle" Index="1" FrameworkAlternate="net-9.0" />
148148
</Parameters>
149149
<Docs>
150-
<param name="target">To be added.</param>
151-
<param name="type">To be added.</param>
152-
<summary>To be added.</summary>
153-
<returns>To be added.</returns>
150+
<param name="target">The target data.</param>
151+
<param name="type">The type of box to create.</param>
152+
<summary>Creates a boxed object of the specified type from the data located at the target reference.</summary>
153+
<returns>A boxed object containing the specified data.</returns>
154154
<remarks>To be added.</remarks>
155+
<exception cref="T:System.ArgumentNullException">The specified type handle is <see langword="null" />.</exception>
156+
<exception cref="T:System.ArgumentException">The specified type cannot have a boxed instance of itself created.</exception>
157+
<exception cref="T:System.NotSupportedException">The passed in type is a byref-like type.</exception>
155158
</Docs>
156159
</Member>
157160
<Member MemberName="CreateSpan&lt;T&gt;">
@@ -1431,10 +1434,11 @@ This method is intended for compiler use rather than use directly in code. `T` m
14311434
<Parameter Name="type" Type="System.RuntimeTypeHandle" Index="0" FrameworkAlternate="net-9.0" />
14321435
</Parameters>
14331436
<Docs>
1434-
<param name="type">To be added.</param>
1435-
<summary>To be added.</summary>
1436-
<returns>To be added.</returns>
1437-
<remarks>To be added.</remarks>
1437+
<param name="type">The type to get the size of.</param>
1438+
<summary>Gets the size of an object of the given type.</summary>
1439+
<returns>The size of instances of the type.</returns>
1440+
<remarks>This API returns the same value as <see cref="M:System.Runtime.CompilerServices.Unsafe.SizeOf``1" /> for the type that <paramref name="type" /> represents.</remarks>
1441+
<exception cref="T:System.ArgumentException">The passed-in type is not a valid type to get the size of.</exception>
14381442
</Docs>
14391443
</Member>
14401444
<Member MemberName="TryEnsureSufficientExecutionStack">

xml/System.Runtime.CompilerServices/TaskAwaiter.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ This type is intended for compiler use only.
128128
<exception cref="T:System.NullReferenceException">The <see cref="T:System.Runtime.CompilerServices.TaskAwaiter" /> object was not properly initialized.</exception>
129129
<exception cref="T:System.OperationCanceledException">The task was canceled.</exception>
130130
<exception cref="T:System.Exception">The task completed in a <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" /> state.</exception>
131+
<exception cref="T:System.Threading.Tasks.TaskCanceledException">The task was canceled.</exception>
131132
</Docs>
132133
</Member>
133134
<Member MemberName="IsCompleted">

xml/System.Runtime.CompilerServices/TaskAwaiter`1.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ This type is intended for compiler use only.
144144
<exception cref="T:System.NullReferenceException">The <see cref="T:System.Runtime.CompilerServices.TaskAwaiter`1" /> object was not properly initialized.</exception>
145145
<exception cref="T:System.OperationCanceledException">The task was canceled.</exception>
146146
<exception cref="T:System.Exception">The task completed in a <see cref="F:System.Threading.Tasks.TaskStatus.Faulted" /> state.</exception>
147+
<exception cref="T:System.Threading.Tasks.TaskCanceledException">The task was canceled.</exception>
147148
</Docs>
148149
</Member>
149150
<Member MemberName="IsCompleted">

0 commit comments

Comments
 (0)