Skip to content

Commit b648c90

Browse files
carlossanlopgewarrenStephenMolloy
authored
Port assorted docs from runtime (#8414)
* Port assorted docs for GA * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Update xml/System.Runtime.Serialization/ISerializationSurrogateProvider2.xml Co-authored-by: Steve Molloy <[email protected]> * Update xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml * Update xml/System.Security.Cryptography.X509Certificates/X509AuthorityKeyIdentifierExtension.xml Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Steve Molloy <[email protected]>
1 parent 96ea36d commit b648c90

File tree

35 files changed

+1067
-542
lines changed

35 files changed

+1067
-542
lines changed

xml/Microsoft.Extensions.DependencyInjection/DefaultServiceProviderFactory.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,7 @@
162162
<summary>Creates an <see cref="T:System.IServiceProvider" /> from the container builder.</summary>
163163
<returns>The newly created service provider.</returns>
164164
<remarks>To be added.</remarks>
165+
<inheritdoc cref="M:Microsoft.Extensions.DependencyInjection.IServiceProviderFactory`1.CreateServiceProvider(`0)" />
165166
</Docs>
166167
</Member>
167168
</Members>

xml/System.Diagnostics.CodeAnalysis/UnscopedRefAttribute.xml

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,18 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
24-
<remarks>To be added.</remarks>
23+
<summary>Used to indicate a byref escapes and is not scoped.</summary>
24+
<remarks>
25+
<para> There are several cases where the C# compiler treats a <see langword="ref" /> as implicitly <see langword="scoped" /> - where the compiler does not allow the <see langword="ref" /> to escape the method.</para>
26+
<para> For example:</para>
27+
<ol>
28+
<li><see langword="this" /> for <see langword="struct" /> instance methods.</li>
29+
<li><see langword="ref" /> parameters that refer to <see langword="ref" /><see langword="struct" /> types.</li>
30+
<li><see langword="out" /> parameters.</li>
31+
</ol>
32+
<para> This attribute is used in those instances where the <see langword="ref" /> should be allowed to escape.</para>
33+
<para> Applying this attribute, in any form, has impact on consumers of the applicable API. It is necessary for API authors to understand the lifetime implications of applying this attribute and how it may impact their users.</para>
34+
</remarks>
2535
</Docs>
2636
<Members>
2737
<Member MemberName=".ctor">
@@ -37,7 +47,7 @@
3747
</AssemblyInfo>
3848
<Parameters />
3949
<Docs>
40-
<summary>To be added.</summary>
50+
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnscopedRefAttribute" /> class.</summary>
4151
<remarks>To be added.</remarks>
4252
</Docs>
4353
</Member>

xml/System.Diagnostics.Eventing.Reader/EventBookmark.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@
6262
<Parameter Name="bookmarkXml" Type="System.String" Index="0" FrameworkAlternate="dotnet-plat-ext-7.0;windowsdesktop-7.0" />
6363
</Parameters>
6464
<Docs>
65-
<param name="bookmarkXml">To be added.</param>
66-
<summary>To be added.</summary>
65+
<param name="bookmarkXml">An XML string that represents the bookmark.</param>
66+
<summary>Creates a bookmark that identifies an event in a channel.</summary>
6767
<remarks>To be added.</remarks>
6868
</Docs>
6969
</Member>
@@ -110,7 +110,7 @@
110110
<ReturnType>System.String</ReturnType>
111111
</ReturnValue>
112112
<Docs>
113-
<summary>To be added.</summary>
113+
<summary>Gets the XML string that represents the bookmark.</summary>
114114
<value>To be added.</value>
115115
<remarks>To be added.</remarks>
116116
</Docs>

xml/System.Diagnostics/InitializingSwitchEventArgs.xml

Lines changed: 1 addition & 1 deletion
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>Provides data for the <see cref="E:System.Diagnostics.Switch.Initializing">Switch.Initializing</see> event.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>

xml/System.Diagnostics/InitializingTraceSourceEventArgs.xml

Lines changed: 1 addition & 1 deletion
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>Provides data for the <see cref="E:System.Diagnostics.TraceSource.Initializing">TraceSource.Initializing</see> event.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>

xml/System.Diagnostics/Switch.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@
319319
<ReturnType>System.String</ReturnType>
320320
</ReturnValue>
321321
<Docs>
322-
<summary>To be added.</summary>
322+
<summary>Gets the default value assigned in the constructor.</summary>
323323
<value>To be added.</value>
324324
<remarks>To be added.</remarks>
325325
</Docs>
@@ -520,7 +520,7 @@
520520
<ReturnType>System.EventHandler&lt;System.Diagnostics.InitializingSwitchEventArgs&gt;</ReturnType>
521521
</ReturnValue>
522522
<Docs>
523-
<summary>To be added.</summary>
523+
<summary>Occurs when a <see cref="T:System.Diagnostics.Switch" /> needs to be initialized.</summary>
524524
<remarks>To be added.</remarks>
525525
</Docs>
526526
</Member>
@@ -638,7 +638,7 @@
638638
</ReturnValue>
639639
<Parameters />
640640
<Docs>
641-
<summary>To be added.</summary>
641+
<summary>Refreshes the trace configuration data.</summary>
642642
<remarks>To be added.</remarks>
643643
</Docs>
644644
</Member>

xml/System.Diagnostics/Trace.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1159,7 +1159,7 @@ End of list of errors
11591159
<ReturnType>System.EventHandler</ReturnType>
11601160
</ReturnValue>
11611161
<Docs>
1162-
<summary>To be added.</summary>
1162+
<summary>Occurs when a <see cref="T:System.Diagnostics.TraceSource" /> needs to be refreshed from configuration.</summary>
11631163
<remarks>To be added.</remarks>
11641164
</Docs>
11651165
</Member>

xml/System.Diagnostics/TraceConfiguration.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
</ReturnValue>
3636
<Parameters />
3737
<Docs>
38-
<summary>To be added.</summary>
38+
<summary>Registers the configuration system to apply settings from configuration files to <see cref="T:System.Diagnostics.TraceSource" /> and related classes.</summary>
3939
<remarks>To be added.</remarks>
4040
</Docs>
4141
</Member>

xml/System.Diagnostics/TraceSource.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ The preceding .NET Framework app configuration file example demonstrates removin
388388
<ReturnType>System.Diagnostics.SourceLevels</ReturnType>
389389
</ReturnValue>
390390
<Docs>
391-
<summary>To be added.</summary>
391+
<summary>Gets the default level assigned in the constructor.</summary>
392392
<value>To be added.</value>
393393
<remarks>To be added.</remarks>
394394
</Docs>
@@ -527,7 +527,7 @@ The preceding .NET Framework app configuration file example demonstrates removin
527527
<ReturnType>System.EventHandler&lt;System.Diagnostics.InitializingTraceSourceEventArgs&gt;</ReturnType>
528528
</ReturnValue>
529529
<Docs>
530-
<summary>To be added.</summary>
530+
<summary>Occurs when a <see cref="T:System.Diagnostics.TraceSource" /> needs to be initialized.</summary>
531531
<remarks>To be added.</remarks>
532532
</Docs>
533533
</Member>

xml/System.Formats.Asn1/AsnWriter.xml

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,16 @@
6262
<Parameter Name="initialCapacity" Type="System.Int32" Index="1" FrameworkAlternate="net-7.0" />
6363
</Parameters>
6464
<Docs>
65-
<param name="ruleSet">To be added.</param>
66-
<param name="initialCapacity">To be added.</param>
67-
<summary>To be added.</summary>
68-
<remarks>To be added.</remarks>
65+
<param name="ruleSet">The encoding constraints for the writer.</param>
66+
<param name="initialCapacity">The minimum capacity with which to initialize the underlying buffer.</param>
67+
<summary>Initializes a new instance of <see cref="T:System.Formats.Asn1.AsnWriter" /> with a given set of encoding rules and an initial capacity.</summary>
68+
<remarks>Specifying <paramref name="initialCapacity" /> with a value of zero behaves as if no initial capacity were specified.</remarks>
69+
<exception cref="T:System.ArgumentOutOfRangeException">
70+
<paramref name="ruleSet" /> is not defined.
71+
72+
-or-
73+
74+
<paramref name="initialCapacity" /> is a negative number.</exception>
6975
</Docs>
7076
</Member>
7177
<Member MemberName="CopyTo">

0 commit comments

Comments
 (0)