Skip to content

Commit b54b56a

Browse files
AnipikRon Petrusha
authored and
Ron Petrusha
committed
Adding Api-docs for System.Runtime.CompilerServices (#2775)
* Adding docs for undocumented apis * Adding fullstop and some other feedback Co-Authored-By: Carlos Sanchez Lopez <1175054+carlossanlop@users.noreply.github.com> * Addressing feedback Co-Authored-By: Ron Petrusha <ronpet@microsoft.com> * correcting switch Expression ctor for unmatched value * Fixed bad cref.
1 parent 73f7adb commit b54b56a

8 files changed

+39
-38
lines changed

xml/System.Runtime.CompilerServices/CallerArgumentExpressionAttribute.xml

+6-6
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
</Attribute>
2020
</Attributes>
2121
<Docs>
22-
<summary>To be added.</summary>
22+
<summary>Allows capturing of the expressions passed to a method.</summary>
2323
<remarks>To be added.</remarks>
2424
</Docs>
2525
<Members>
@@ -39,8 +39,8 @@
3939
<Parameter Name="parameterName" Type="System.String" />
4040
</Parameters>
4141
<Docs>
42-
<param name="parameterName">To be added.</param>
43-
<summary>To be added.</summary>
42+
<param name="parameterName">The name of the targeted parameter.</param>
43+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute" /> class.</summary>
4444
<remarks>To be added.</remarks>
4545
</Docs>
4646
</Member>
@@ -60,10 +60,10 @@
6060
<ReturnType>System.String</ReturnType>
6161
</ReturnValue>
6262
<Docs>
63-
<summary>To be added.</summary>
64-
<value>To be added.</value>
63+
<summary>Gets the target parameter name of the CallerArgumentExpression</summary>
64+
<value>The name of the targeted parameter of the CallerArgumentExpression</value>
6565
<remarks>To be added.</remarks>
6666
</Docs>
6767
</Member>
6868
</Members>
69-
</Type>
69+
</Type>

xml/System.Runtime.CompilerServices/ConfiguredAsyncDisposable.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@
4848
</ReturnValue>
4949
<Parameters />
5050
<Docs>
51-
<summary>To be added.</summary>
52-
<returns>To be added.</returns>
51+
<summary>Asynchronously releases the unmanaged resources used by the <see cref="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable" />.</summary>
52+
<returns>A task that represents the asynchronous dispose operation.</returns>
5353
<remarks>To be added.</remarks>
5454
</Docs>
5555
</Member>

xml/System.Runtime.CompilerServices/ConfiguredCancelableAsyncEnumerable`1+Enumerator.xml

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
</Attribute>
2727
</Attributes>
2828
<Docs>
29+
<typeparam name="T">The type of values to enumerate.</typeparam>
2930
<summary>Provides an awaitable async enumerator that enables cancelable iteration and configured awaits.</summary>
3031
<remarks>To be added.</remarks>
3132
</Docs>

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
</Attribute>
2727
</Attributes>
2828
<Docs>
29-
<typeparam name="T">To be added.</typeparam>
29+
<typeparam name="T">The type of values to enumerate.</typeparam>
3030
<summary>Provides an awaitable async enumerable that enables cancelable iteration and configured awaits.</summary>
3131
<remarks>To be added.</remarks>
3232
</Docs>
@@ -85,8 +85,8 @@ This will replace any previous value set by <xref:System.Runtime.CompilerService
8585
</ReturnValue>
8686
<Parameters />
8787
<Docs>
88-
<summary>To be added.</summary>
89-
<returns>To be added.</returns>
88+
<summary>Returns an enumerator that iterates asynchronously through collections that enables cancelable iteration and configured awaits.</summary>
89+
<returns>An enumerator for the <see cref="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1" /> class.</returns>
9090
<remarks>To be added.</remarks>
9191
</Docs>
9292
</Member>

xml/System.Runtime.CompilerServices/EnumeratorCancellationAttribute.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
</Attribute>
2323
</Attributes>
2424
<Docs>
25-
<summary>To be added.</summary>
25+
<summary>Allows users of async-enumerable methods to mark the parameter that should receive the cancellation token value from <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)" />.</summary>
2626
<remarks>To be added.</remarks>
2727
</Docs>
2828
<Members>
@@ -42,9 +42,9 @@
4242
</AssemblyInfo>
4343
<Parameters />
4444
<Docs>
45-
<summary>To be added.</summary>
45+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.EnumeratorCancellationAttribute" /> class.</summary>
4646
<remarks>To be added.</remarks>
4747
</Docs>
4848
</Member>
4949
</Members>
50-
</Type>
50+
</Type>

xml/System.Runtime.CompilerServices/MethodImplOptions.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@
120120
</ReturnValue>
121121
<MemberValue>512</MemberValue>
122122
<Docs>
123-
<summary>To be added.</summary>
123+
<summary>The method contains a hot path and should be optimized.</summary>
124124
</Docs>
125125
</Member>
126126
<Member MemberName="ForwardRef">
@@ -392,4 +392,4 @@
392392
</Docs>
393393
</Member>
394394
</Members>
395-
</Type>
395+
</Type>

xml/System.Runtime.CompilerServices/RuntimeFeature.xml

+5-5
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@
7676
<ReturnType>System.Boolean</ReturnType>
7777
</ReturnValue>
7878
<Docs>
79-
<summary>To be added.</summary>
80-
<value>To be added.</value>
81-
<remarks>To be added.</remarks>
79+
<summary></summary>
80+
<value>Gets a value that determines whether the runtime compiles dynamic code.</value>
81+
<remarks><see langword="true" /> if the runtime compiles dynamic code; <see langword="false" /> if it does not compile dynamic code or doesn't know about this property.</remarks>
8282
</Docs>
8383
</Member>
8484
<Member MemberName="IsDynamicCodeSupported">
@@ -104,8 +104,8 @@
104104
<ReturnType>System.Boolean</ReturnType>
105105
</ReturnValue>
106106
<Docs>
107-
<summary>To be added.</summary>
108-
<value>To be added.</value>
107+
<summary>Gets a value that determines whether the runtime supports dynamic code.</summary>
108+
<value> <see langword="true" /> if the runtime supports dynamic code; <see langword="false" /> if it either doesn't support dynamic code or doesn't know about this property.</value>
109109
<remarks>To be added.</remarks>
110110
</Docs>
111111
</Member>

xml/System.Runtime.CompilerServices/SwitchExpressionException.xml

+17-17
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ A C# example of an expression that would throw this exception:
5151
</AssemblyInfo>
5252
<Parameters />
5353
<Docs>
54-
<summary>To be added.</summary>
54+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.SwitchExpressionException" /> class.</summary>
5555
<remarks>To be added.</remarks>
5656
</Docs>
5757
</Member>
@@ -75,8 +75,8 @@ A C# example of an expression that would throw this exception:
7575
<Parameter Name="innerException" Type="System.Exception" />
7676
</Parameters>
7777
<Docs>
78-
<param name="innerException">To be added.</param>
79-
<summary>To be added.</summary>
78+
<param name="innerException">The exception that is the cause of the current exception. If the <paramref name="innerException" /> parameter is not <see langword="null" />, the current exception is raised in a <see langword="catch" /> block that handles the inner exception.</param>
79+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.SwitchExpressionException" /> class with a specified error message and a reference to the inner exception that is the cause of this exception.</summary>
8080
<remarks>To be added.</remarks>
8181
</Docs>
8282
</Member>
@@ -100,8 +100,8 @@ A C# example of an expression that would throw this exception:
100100
<Parameter Name="unmatchedValue" Type="System.Object" />
101101
</Parameters>
102102
<Docs>
103-
<param name="unmatchedValue">To be added.</param>
104-
<summary>To be added.</summary>
103+
<param name="unmatchedValue">The switch value that does not match any switch cases.</param>
104+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.SwitchExpressionException" /> class with an unmatched switch value.</summary>
105105
<remarks>To be added.</remarks>
106106
</Docs>
107107
</Member>
@@ -125,8 +125,8 @@ A C# example of an expression that would throw this exception:
125125
<Parameter Name="message" Type="System.String" />
126126
</Parameters>
127127
<Docs>
128-
<param name="message">To be added.</param>
129-
<summary>To be added.</summary>
128+
<param name="message">The message to display to the end user.</param>
129+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.SwitchExpressionException" /> class with the specified message.</summary>
130130
<remarks>To be added.</remarks>
131131
</Docs>
132132
</Member>
@@ -151,9 +151,9 @@ A C# example of an expression that would throw this exception:
151151
<Parameter Name="innerException" Type="System.Exception" />
152152
</Parameters>
153153
<Docs>
154-
<param name="message">To be added.</param>
155-
<param name="innerException">To be added.</param>
156-
<summary>To be added.</summary>
154+
<param name="message">The message to display to the end user.</param>
155+
<param name="innerException">A reference to the inner exception that is the cause of this exception.</param>
156+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.SwitchExpressionException" /> class with the specified detailed description and the specified exception.</summary>
157157
<remarks>To be added.</remarks>
158158
</Docs>
159159
</Member>
@@ -181,9 +181,9 @@ A C# example of an expression that would throw this exception:
181181
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
182182
</Parameters>
183183
<Docs>
184-
<param name="info">To be added.</param>
185-
<param name="context">To be added.</param>
186-
<summary>To be added.</summary>
184+
<param name="info">Stores the data that was being used to serialize or deserialize the object that the <see cref="T:System.ComponentModel.Design.Serialization.CodeDomSerializer" /> was serializing or deserializing.</param>
185+
<param name="context">Describes the source and destination of the stream that generated the exception, as well as a means for serialization to retain that context and an additional caller-defined context.</param>
186+
<summary>Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with the parameter name and additional exception information.</summary>
187187
<remarks>To be added.</remarks>
188188
</Docs>
189189
</Member>
@@ -206,8 +206,8 @@ A C# example of an expression that would throw this exception:
206206
<ReturnType>System.String</ReturnType>
207207
</ReturnValue>
208208
<Docs>
209-
<summary>To be added.</summary>
210-
<value>To be added.</value>
209+
<summary>Gets the exception message.</summary>
210+
<value>The complete message string.</value>
211211
<remarks>To be added.</remarks>
212212
</Docs>
213213
</Member>
@@ -231,8 +231,8 @@ A C# example of an expression that would throw this exception:
231231
<ReturnType>System.Object</ReturnType>
232232
</ReturnValue>
233233
<Docs>
234-
<summary>To be added.</summary>
235-
<value>To be added.</value>
234+
<summary>Gets the unmatched value associated with the exception.</summary>
235+
<value>The unmatched value causing the exception.</value>
236236
<remarks>To be added.</remarks>
237237
</Docs>
238238
</Member>

0 commit comments

Comments
 (0)