Skip to content

Commit d5087db

Browse files
ericstjericstj
committed
System.Runtime.CompilerServices docs
1 parent 8a08e01 commit d5087db

21 files changed

+117
-69
lines changed

‎xml/System.Runtime.CompilerServices/CompilerLoweringPreserveAttribute.xml‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,12 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
24-
<remarks>To be added.</remarks>
23+
<summary>
24+
<para>When applied to an attribute class, instructs the compiler to flow applications of that attribute, from source code down to compiler-generated symbols. This can help IL-based analysis tools.</para>
25+
</summary>
26+
<remarks>
27+
<para>One example where this attribute applies is in C# primary constructor parameters. If an attribute marked with <see cref="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute" /> gets applied to a primary constructor parameter, the attribute will also be applied to any compiler-generated fields storing that parameter.</para>
28+
</remarks>
2529
</Docs>
2630
<Members>
2731
<Member MemberName=".ctor">
@@ -37,7 +41,7 @@
3741
</AssemblyInfo>
3842
<Parameters />
3943
<Docs>
40-
<summary>To be added.</summary>
44+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute" /> class.</summary>
4145
<remarks>To be added.</remarks>
4246
</Docs>
4347
</Member>

‎xml/System.Runtime.CompilerServices/ConditionalWeakTable`2.xml‎

Lines changed: 41 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -433,11 +433,17 @@
433433
<Parameter Name="valueFactory" Type="System.Func&lt;TKey,TValue&gt;" Index="1" FrameworkAlternate="net-10.0" />
434434
</Parameters>
435435
<Docs>
436-
<param name="key">To be added.</param>
437-
<param name="valueFactory">To be added.</param>
438-
<summary>To be added.</summary>
439-
<returns>To be added.</returns>
440-
<remarks>To be added.</remarks>
436+
<param name="key">The key of the value to find. It cannot be <see langword="null" />.</param>
437+
<param name="valueFactory">The callback that creates a value for key, if one does not exist already. It cannot be <see langword="null" />.</param>
438+
<summary>
439+
<para>Searches for a specified key in the table and returns the corresponding value. If the key does not exist in the table, the method invokes the supplied factory to create a value that is bound to the specified key.</para>
440+
</summary>
441+
<returns>The value bound to <typeparamref name="TKey" /> in the current <see cref="T:System.Runtime.CompilerServices.ConditionalWeakTable`2" /> instance, after the method completes.</returns>
442+
<remarks>
443+
<para>If multiple threads try to initialize the same key, the table may invoke <paramref name="valueFactory" /> multiple times with the same key. Exactly one of these calls will succeed and the returned value of that call will be the one added to the table and returned by all the racing <see cref="M:System.Runtime.CompilerServices.ConditionalWeakTable`2.GetOrAdd(`0,System.Func{`0,`1})" /> calls. This rule permits the table to invoke <paramref name="valueFactory" /> outside the internal table lock, to prevent deadlocks.</para>
444+
</remarks>
445+
<exception cref="T:System.ArgumentNullException">
446+
<paramref name="key" /> or <paramref name="valueFactory" /> are <see langword="null" />.</exception>
441447
</Docs>
442448
</Member>
443449
<Member MemberName="GetOrAdd">
@@ -469,11 +475,15 @@
469475
<Parameter Name="value" Type="TValue" Index="1" FrameworkAlternate="net-10.0" />
470476
</Parameters>
471477
<Docs>
472-
<param name="key">To be added.</param>
473-
<param name="value">To be added.</param>
474-
<summary>To be added.</summary>
475-
<returns>To be added.</returns>
478+
<param name="key">The key of the value to find. It cannot be <see langword="null" />.</param>
479+
<param name="value">The value to add and bind to <typeparamref name="TKey" />, if one does not exist already.</param>
480+
<summary>
481+
<para>Searches for a specified key in the table and returns the corresponding value. If the key does not exist in the table, the method adds the given value and binds it to the specified key.</para>
482+
</summary>
483+
<returns>The value bound to <typeparamref name="TKey" /> in the current <see cref="T:System.Runtime.CompilerServices.ConditionalWeakTable`2" /> instance, after the method completes.</returns>
476484
<remarks>To be added.</remarks>
485+
<exception cref="T:System.ArgumentNullException">
486+
<paramref name="key" /> is <see langword="null" />.</exception>
477487
</Docs>
478488
</Member>
479489
<Member MemberName="GetOrAdd&lt;TArg&gt;">
@@ -519,13 +529,19 @@
519529
<Parameter Name="factoryArgument" Type="TArg" Index="2" FrameworkAlternate="net-10.0" />
520530
</Parameters>
521531
<Docs>
522-
<typeparam name="TArg">To be added.</typeparam>
523-
<param name="key">To be added.</param>
524-
<param name="valueFactory">To be added.</param>
525-
<param name="factoryArgument">To be added.</param>
526-
<summary>To be added.</summary>
527-
<returns>To be added.</returns>
528-
<remarks>To be added.</remarks>
532+
<typeparam name="TArg">The type of the additional argument to use with the value factory.</typeparam>
533+
<param name="key">The key of the value to find. It cannot be <see langword="null" />.</param>
534+
<param name="valueFactory">The callback that creates a value for key, if one does not exist already. It cannot be <see langword="null" />.</param>
535+
<param name="factoryArgument">The additional argument to supply to <paramref name="valueFactory" /> upon invocation.</param>
536+
<summary>
537+
<para>Searches for a specified key in the table and returns the corresponding value. If the key does not exist in the table, the method invokes the supplied factory to create a value that is bound to the specified key.</para>
538+
</summary>
539+
<returns>The value bound to <typeparamref name="TKey" /> in the current <see cref="T:System.Runtime.CompilerServices.ConditionalWeakTable`2" /> instance, after the method completes.</returns>
540+
<remarks>
541+
<para>If multiple threads try to initialize the same key, the table may invoke <paramref name="valueFactory" /> multiple times with the same key. Exactly one of these calls will succeed and the returned value of that call will be the one added to the table and returned by all the racing <see cref="M:System.Runtime.CompilerServices.ConditionalWeakTable`2.GetOrAdd``1(`0,System.Func{`0,``0,`1},``0)" /> calls. This rule permits the table to invoke <paramref name="valueFactory" /> outside the internal table lock, to prevent deadlocks.</para>
542+
</remarks>
543+
<exception cref="T:System.ArgumentNullException">
544+
<paramref name="key" /> or <paramref name="valueFactory" /> are <see langword="null" />.</exception>
529545
</Docs>
530546
</Member>
531547
<Member MemberName="GetOrCreateValue">
@@ -792,11 +808,14 @@ Note: In the <see href="https://go.microsoft.com/fwlink/?LinkID=247912">.NET for
792808
</Parameter>
793809
</Parameters>
794810
<Docs>
795-
<param name="key">To be added.</param>
796-
<param name="value">To be added.</param>
797-
<summary>To be added.</summary>
798-
<returns>To be added.</returns>
811+
<param name="key">The key to remove.</param>
812+
<param name="value">value removed from the table, if it was present.</param>
813+
<summary>Removes a key and its value from the table, and returns the removed value if it was present.</summary>
814+
<returns>
815+
<see langword="true" /> if the key is found and removed; otherwise, <see langword="false" />.</returns>
799816
<remarks>To be added.</remarks>
817+
<exception cref="T:System.ArgumentNullException">
818+
<paramref name="key" /> is <see langword="null" />.</exception>
800819
</Docs>
801820
</Member>
802821
<Member MemberName="System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;TKey,TValue&gt;&gt;.GetEnumerator">
@@ -943,6 +962,8 @@ retrieved. Additionally, it may not return all entries that were present when th
943962
<returns>
944963
<see langword="true" /> if the key/value pair was added; <see langword="false" /> if the table already contained the key.</returns>
945964
<remarks>To be added.</remarks>
965+
<exception cref="T:System.ArgumentNullException">
966+
<paramref name="key" /> is <see langword="null" />.</exception>
946967
</Docs>
947968
</Member>
948969
<Member MemberName="TryGetValue">

‎xml/System.Runtime.CompilerServices/DefaultInterpolatedStringHandler.xml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -539,8 +539,10 @@ This is intended to be called only by compiler-generated code. Arguments are not
539539
</ReturnValue>
540540
<Parameters />
541541
<Docs>
542-
<summary>To be added.</summary>
543-
<remarks>To be added.</remarks>
542+
<summary>Clears the handler.</summary>
543+
<remarks>
544+
<para>This releases any resources used by the handler. The method should be invoked only once and as the last thing performed on the handler. Subsequent use is erroneous, ill-defined, and may destabilize the process, as may using any other copies of the handler after <see cref="M:System.Runtime.CompilerServices.DefaultInterpolatedStringHandler.Clear" /> is called on any one of them.</para>
545+
</remarks>
544546
</Docs>
545547
</Member>
546548
<Member MemberName="Text">
@@ -559,7 +561,7 @@ This is intended to be called only by compiler-generated code. Arguments are not
559561
<ReturnType>System.ReadOnlySpan&lt;System.Char&gt;</ReturnType>
560562
</ReturnValue>
561563
<Docs>
562-
<summary>To be added.</summary>
564+
<summary>Gets a span of the characters appended to the handler.</summary>
563565
<value>To be added.</value>
564566
<remarks>To be added.</remarks>
565567
</Docs>

‎xml/System.Runtime.CompilerServices/ExtensionMarkerAttribute.xml‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@
2828
</Attribute>
2929
</Attributes>
3030
<Docs>
31-
<summary>To be added.</summary>
31+
<summary>
32+
<para>This attribute is used to mark extension members and associate them with a specific marker type (which provides detailed information about an extension block and its receiver parameter).</para>
33+
<para>This attribute should not be used by developers in source code.</para>
34+
</summary>
3235
<remarks>To be added.</remarks>
3336
</Docs>
3437
<Members>
@@ -48,8 +51,8 @@
4851
<Parameter Name="name" Type="System.String" />
4952
</Parameters>
5053
<Docs>
51-
<param name="name">To be added.</param>
52-
<summary>To be added.</summary>
54+
<param name="name">The name of the marker type this extension member is associated with.</param>
55+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.ExtensionMarkerAttribute" /> class.</summary>
5356
<remarks>To be added.</remarks>
5457
</Docs>
5558
</Member>
@@ -69,7 +72,7 @@
6972
<ReturnType>System.String</ReturnType>
7073
</ReturnValue>
7174
<Docs>
72-
<summary>To be added.</summary>
75+
<summary>The name of the marker type this extension member is associated with.</summary>
7376
<value>To be added.</value>
7477
<remarks>To be added.</remarks>
7578
</Docs>

‎xml/System.Runtime.CompilerServices/InlineArray10`1.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
</Attribute>
3131
</Attributes>
3232
<Docs>
33-
<typeparam name="T">To be added.</typeparam>
34-
<summary>To be added.</summary>
33+
<typeparam name="T">The type of elements in the array.</typeparam>
34+
<summary>Represents an inline array of <typeparamref name="T" /> with a fixed length of 10.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
<Members />

‎xml/System.Runtime.CompilerServices/InlineArray11`1.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
</Attribute>
3131
</Attributes>
3232
<Docs>
33-
<typeparam name="T">To be added.</typeparam>
34-
<summary>To be added.</summary>
33+
<typeparam name="T">The type of elements in the array.</typeparam>
34+
<summary>Represents an inline array of <typeparamref name="T" /> with a fixed length of 11.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
<Members />

‎xml/System.Runtime.CompilerServices/InlineArray12`1.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
</Attribute>
3131
</Attributes>
3232
<Docs>
33-
<typeparam name="T">To be added.</typeparam>
34-
<summary>To be added.</summary>
33+
<typeparam name="T">The type of elements in the array.</typeparam>
34+
<summary>Represents an inline array of <typeparamref name="T" /> with a fixed length of 12.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
<Members />

‎xml/System.Runtime.CompilerServices/InlineArray13`1.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
</Attribute>
3131
</Attributes>
3232
<Docs>
33-
<typeparam name="T">To be added.</typeparam>
34-
<summary>To be added.</summary>
33+
<typeparam name="T">The type of elements in the array.</typeparam>
34+
<summary>Represents an inline array of <typeparamref name="T" /> with a fixed length of 13.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
<Members />

‎xml/System.Runtime.CompilerServices/InlineArray14`1.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
</Attribute>
3131
</Attributes>
3232
<Docs>
33-
<typeparam name="T">To be added.</typeparam>
34-
<summary>To be added.</summary>
33+
<typeparam name="T">The type of elements in the array.</typeparam>
34+
<summary>Represents an inline array of <typeparamref name="T" /> with a fixed length of 14.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
<Members />

‎xml/System.Runtime.CompilerServices/InlineArray15`1.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
</Attribute>
3131
</Attributes>
3232
<Docs>
33-
<typeparam name="T">To be added.</typeparam>
34-
<summary>To be added.</summary>
33+
<typeparam name="T">The type of elements in the array.</typeparam>
34+
<summary>Represents an inline array of <typeparamref name="T" /> with a fixed length of 15.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
<Members />

0 commit comments

Comments
 (0)