Skip to content

Commit 9202663

Browse files
author
Ron Petrusha
authored
Merge pull request #3288 from dotnet/master
Update live with current master
2 parents 2b78f05 + cc321cf commit 9202663

File tree

34 files changed

+275
-219
lines changed

34 files changed

+275
-219
lines changed

‎xml/System.Diagnostics/DiagnosticListener.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ When you subscribe to this, you get callbacks for all NotificationListeners in t
153153
<remarks>
154154
<format type="text/markdown"><![CDATA[
155155
156-
If setup for the notification is expensive, you can call `IsEnabled` before performing this setup. Producers may optionally call `IsEnabled` before calling <xref:System.Diagnostics.DiagnosticListener.IsEnabled(System.String) in performance-critical parts of the application to determine whether there are any listeners to the <xref:System.Diagnostics.DiagnosticListener>.
156+
If setup for the notification is expensive, you can call `IsEnabled()` before performing this setup. Producers may optionally call `IsEnabled()` before calling <xref:System.Diagnostics.DiagnosticListener.IsEnabled(System.String)> in performance-critical parts of the application to determine whether there are any listeners to the <xref:System.Diagnostics.DiagnosticListener>.
157157
158158
]]></format>
159159
</remarks>

‎xml/System.DirectoryServices.AccountManagement/PrincipalException.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@
4343
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" Index="1" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0" />
4444
</Parameters>
4545
<Docs>
46-
<param name="info">To be added.</param>
47-
<param name="context">To be added.</param>
48-
<summary>To be added.</summary>
46+
<param name="info">The error information.</param>
47+
<param name="context">The streaming context.</param>
48+
<summary>Initializes a new instance of the <see cref="T:System.DirectoryServices.AccountManagement.PrincipalException" /> class using the provided serialization information and streaming context.</summary>
4949
<remarks>To be added.</remarks>
5050
</Docs>
5151
</Member>

‎xml/System.Reflection.Metadata.Ecma335/MethodBodyAttributes.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
</Attribute>
2222
</Attributes>
2323
<Docs>
24-
<summary>To be added.</summary>
24+
<summary>Defines method body attributes.</summary>
2525
<remarks>To be added.</remarks>
2626
</Docs>
2727
<Members>
@@ -45,7 +45,7 @@
4545
</ReturnValue>
4646
<MemberValue>1</MemberValue>
4747
<Docs>
48-
<summary>To be added.</summary>
48+
<summary>Initializes any locals the method defines to zero and dynamically allocates local memory.</summary>
4949
</Docs>
5050
</Member>
5151
<Member MemberName="None">
@@ -68,7 +68,7 @@
6868
</ReturnValue>
6969
<MemberValue>0</MemberValue>
7070
<Docs>
71-
<summary>To be added.</summary>
71+
<summary>Performs no local memory initialization.</summary>
7272
</Docs>
7373
</Member>
7474
</Members>

‎xml/System.Reflection.Metadata.Ecma335/MethodBodyStreamEncoder+MethodBody.xml

Lines changed: 7 additions & 7 deletions
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>Describes a method body. This class is meant to used along with the <see cref="T:System.Reflection.Metadata.Ecma335.MethodBodyStreamEncoder" /> class.</summary>
2626
<remarks>To be added.</remarks>
2727
</Docs>
2828
<Members>
@@ -45,8 +45,8 @@
4545
<ReturnType>System.Reflection.Metadata.Ecma335.ExceptionRegionEncoder</ReturnType>
4646
</ReturnValue>
4747
<Docs>
48-
<summary>To be added.</summary>
49-
<value>To be added.</value>
48+
<summary>Gets an encoder object that can be used to encode exception regions to the method body.</summary>
49+
<value>An exception region encoder instance.</value>
5050
<remarks>To be added.</remarks>
5151
</Docs>
5252
</Member>
@@ -69,8 +69,8 @@
6969
<ReturnType>System.Reflection.Metadata.Blob</ReturnType>
7070
</ReturnValue>
7171
<Docs>
72-
<summary>To be added.</summary>
73-
<value>To be added.</value>
72+
<summary>Gets a blob reserved for instructions.</summary>
73+
<value>A blob reserved for instructions.</value>
7474
<remarks>To be added.</remarks>
7575
</Docs>
7676
</Member>
@@ -93,8 +93,8 @@
9393
<ReturnType>System.Int32</ReturnType>
9494
</ReturnValue>
9595
<Docs>
96-
<summary>To be added.</summary>
97-
<value>To be added.</value>
96+
<summary>Gets the offset of the encoded method body in the method body stream.</summary>
97+
<value>The offset of the encoded method body in the method body stream.</value>
9898
<remarks>To be added.</remarks>
9999
</Docs>
100100
</Member>

‎xml/System.Reflection.Metadata.Ecma335/MethodBodyStreamEncoder.xml

Lines changed: 31 additions & 31 deletions
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>Provides an encoder for a method body stream.</summary>
2626
<remarks>To be added.</remarks>
2727
</Docs>
2828
<Members>
@@ -75,12 +75,12 @@
7575
<Parameter Name="attributes" Type="System.Reflection.Metadata.Ecma335.MethodBodyAttributes" />
7676
</Parameters>
7777
<Docs>
78-
<param name="instructionEncoder">To be added.</param>
79-
<param name="maxStack">To be added.</param>
80-
<param name="localVariablesSignature">To be added.</param>
81-
<param name="attributes">To be added.</param>
82-
<summary>To be added.</summary>
83-
<returns>To be added.</returns>
78+
<param name="instructionEncoder">The instruction encoder.</param>
79+
<param name="maxStack">The maximum stack size.</param>
80+
<param name="localVariablesSignature">The local variables' signature handle.</param>
81+
<param name="attributes">The method body attributes.</param>
82+
<summary>Encodes a method body and adds it to the method body stream.</summary>
83+
<returns>The offset of the encoded body within the method body stream.</returns>
8484
<remarks>To be added.</remarks>
8585
</Docs>
8686
</Member>
@@ -106,13 +106,13 @@
106106
<Parameter Name="hasDynamicStackAllocation" Type="System.Boolean" Index="4" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0" />
107107
</Parameters>
108108
<Docs>
109-
<param name="instructionEncoder">To be added.</param>
110-
<param name="maxStack">To be added.</param>
111-
<param name="localVariablesSignature">To be added.</param>
112-
<param name="attributes">To be added.</param>
113-
<param name="hasDynamicStackAllocation">To be added.</param>
114-
<summary>To be added.</summary>
115-
<returns>To be added.</returns>
109+
<param name="instructionEncoder">The instruction encoder.</param>
110+
<param name="maxStack">The maximum stack size.</param>
111+
<param name="localVariablesSignature">The local variables' signature handle.</param>
112+
<param name="attributes">The method body attributes.</param>
113+
<param name="hasDynamicStackAllocation"><see langword="true" /> if the method allocates from the dynamic local memory pool (the IL contains the <see langword="localloc" /> instruction); <see langword="false" /> otherwise.</param>
114+
<summary>Encodes a method body and adds it to the method body stream, using the provided instruction encoder, maximum stack size, local variables' signature handle, method body attributes, and allowing to indicate whether the method should allocate from the dynamic local memory pool or not.</summary>
115+
<returns>The offset of the encoded body within the method body stream.</returns>
116116
<remarks>To be added.</remarks>
117117
</Docs>
118118
</Member>
@@ -145,14 +145,14 @@
145145
<Parameter Name="attributes" Type="System.Reflection.Metadata.Ecma335.MethodBodyAttributes" />
146146
</Parameters>
147147
<Docs>
148-
<param name="codeSize">To be added.</param>
149-
<param name="maxStack">To be added.</param>
150-
<param name="exceptionRegionCount">To be added.</param>
151-
<param name="hasSmallExceptionRegions">To be added.</param>
152-
<param name="localVariablesSignature">To be added.</param>
153-
<param name="attributes">To be added.</param>
154-
<summary>To be added.</summary>
155-
<returns>To be added.</returns>
148+
<param name="codeSize">The number of bytes to be reserved for instructions.</param>
149+
<param name="maxStack">The maximum stack size.</param>
150+
<param name="exceptionRegionCount">The number of exception regions.</param>
151+
<param name="hasSmallExceptionRegions"><see langword="true" /> if the exception regions should be encoded in small format; <see langword="false" /> otherwise.</param>
152+
<param name="localVariablesSignature">The local variables' signature handle.</param>
153+
<param name="attributes">The method body attributes.</param>
154+
<summary>Encodes a method body and adds it to the method body stream, using the provided code size, maximum stack size, number of exception regions, local variables' signature handle, method body attributes and allowing to indicate whether the exception regions should be encoded in small format or not.</summary>
155+
<returns>The offset of the encoded body within the method body stream.</returns>
156156
<remarks>To be added.</remarks>
157157
</Docs>
158158
</Member>
@@ -181,15 +181,15 @@
181181
<Parameter Name="hasDynamicStackAllocation" Type="System.Boolean" Index="6" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0" />
182182
</Parameters>
183183
<Docs>
184-
<param name="codeSize">To be added.</param>
185-
<param name="maxStack">To be added.</param>
186-
<param name="exceptionRegionCount">To be added.</param>
187-
<param name="hasSmallExceptionRegions">To be added.</param>
188-
<param name="localVariablesSignature">To be added.</param>
189-
<param name="attributes">To be added.</param>
190-
<param name="hasDynamicStackAllocation">To be added.</param>
191-
<summary>To be added.</summary>
192-
<returns>To be added.</returns>
184+
<param name="codeSize">The number of bytes to be reserved for instructions.</param>
185+
<param name="maxStack">The maximum stack size.</param>
186+
<param name="exceptionRegionCount">The number of exception regions.</param>
187+
<param name="hasSmallExceptionRegions"><see langword="true" /> if the exception regions should be encoded in small format; <see langword="false" /> otherwise.</param>
188+
<param name="localVariablesSignature">The local variables' signature handle.</param>
189+
<param name="attributes">The method body attributes.</param>
190+
<param name="hasDynamicStackAllocation"><see langword="true" /> if the method allocates from the dynamic local memory pool (the <see langword="localloc" /> instruction); <see langword="false" /> otherwise.</param>
191+
<summary>Encodes a method body and adds it to the method body stream, using the provided code size, maximum stack size, number of exception regions, local variables' signature handle, method body attributes, allowing to indicate whether the exception regions should be encoded in small format or not, and allowing to indicate whether the method should allocate from the dynamic local memory pool or not.</summary>
192+
<returns>The offset of the encoded body within the method body stream.</returns>
193193
<remarks>To be added.</remarks>
194194
</Docs>
195195
</Member>

‎xml/System.Reflection.Metadata.Ecma335/MethodSignatureEncoder.xml

Lines changed: 9 additions & 9 deletions
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>Provides an encoder for method signatures.</summary>
2626
<remarks>To be added.</remarks>
2727
</Docs>
2828
<Members>
@@ -124,10 +124,10 @@
124124
<Parameter Name="parameters" Type="System.Action&lt;System.Reflection.Metadata.Ecma335.ParametersEncoder&gt;" Index="2" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0" />
125125
</Parameters>
126126
<Docs>
127-
<param name="parameterCount">To be added.</param>
128-
<param name="returnType">To be added.</param>
129-
<param name="parameters">To be added.</param>
130-
<summary>To be added.</summary>
127+
<param name="parameterCount">The number of parameters.</param>
128+
<param name="returnType">The method that is called first to encode the return type.</param>
129+
<param name="parameters">The method that is called second to encode the parameters.</param>
130+
<summary>Encodes the provided return type and parameters.</summary>
131131
<remarks>To be added.</remarks>
132132
</Docs>
133133
</Member>
@@ -155,10 +155,10 @@
155155
<Parameter Name="parameters" Type="System.Reflection.Metadata.Ecma335.ParametersEncoder" RefType="out" Index="2" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0" />
156156
</Parameters>
157157
<Docs>
158-
<param name="parameterCount">To be added.</param>
159-
<param name="returnType">To be added.</param>
160-
<param name="parameters">To be added.</param>
161-
<summary>To be added.</summary>
158+
<param name="parameterCount">The number of parameters.</param>
159+
<param name="returnType">The method that is called first to encode the return types.</param>
160+
<param name="parameters">The method that is called second to encode the parameters.</param>
161+
<summary>Encodes the provided return type and parameters, which must be used in the order they appear in the parameter list.</summary>
162162
<remarks>To be added.</remarks>
163163
</Docs>
164164
</Member>

‎xml/System.Reflection.Metadata.Ecma335/NamedArgumentsEncoder.xml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@
4545
<Parameter Name="builder" Type="System.Reflection.Metadata.BlobBuilder" Index="0" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0" />
4646
</Parameters>
4747
<Docs>
48-
<param name="builder">To be added.</param>
49-
<summary>To be added.</summary>
48+
<param name="builder">A builder for encoding the named argument.</param>
49+
<summary>Initializes a new instance of the <see cref="T:System.Reflection.Metadata.Ecma335.NamedArgumentsEncoder" /> structure.</summary>
5050
<remarks>To be added.</remarks>
5151
</Docs>
5252
</Member>
@@ -75,11 +75,11 @@
7575
<Parameter Name="literal" Type="System.Action&lt;System.Reflection.Metadata.Ecma335.LiteralEncoder&gt;" Index="3" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0" />
7676
</Parameters>
7777
<Docs>
78-
<param name="isField">To be added.</param>
79-
<param name="type">To be added.</param>
80-
<param name="name">To be added.</param>
81-
<param name="literal">To be added.</param>
82-
<summary>To be added.</summary>
78+
<param name="isField"><see langword="true" /> to encode a field, <see langword="false" /> to encode a property.</param>
79+
<param name="type">The method to call first to encode the type of the argument.</param>
80+
<param name="name">The method to call second to encode the name of the field or property.</param>
81+
<param name="literal">The method to call third to encode the literal value of the argument.</param>
82+
<summary>Encodes a named argument (a field or property).</summary>
8383
<remarks>To be added.</remarks>
8484
</Docs>
8585
</Member>
@@ -108,11 +108,11 @@
108108
<Parameter Name="literal" Type="System.Reflection.Metadata.Ecma335.LiteralEncoder" RefType="out" Index="3" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0" />
109109
</Parameters>
110110
<Docs>
111-
<param name="isField">To be added.</param>
112-
<param name="type">To be added.</param>
113-
<param name="name">To be added.</param>
114-
<param name="literal">To be added.</param>
115-
<summary>To be added.</summary>
111+
<param name="isField"><see langword="true" /> to encode a field, <see langword="false" /> to encode a property.</param>
112+
<param name="type">The method to call first to encode the type of the argument.</param>
113+
<param name="name">The method to call second to encode the name of the field or property.</param>
114+
<param name="literal">The method to call third to encode the literal value of the argument.</param>
115+
<summary>Encodes a named argument (a field or property) and returns three encoders that must be used in the order they appear in the parameter list.</summary>
116116
<remarks>To be added.</remarks>
117117
</Docs>
118118
</Member>

‎xml/System.Reflection.Metadata.Ecma335/PortablePdbBuilder.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</Base>
1818
<Interfaces />
1919
<Docs>
20-
<summary>To be added.</summary>
20+
<summary>Represents the builder of a Portable PDB image.</summary>
2121
<remarks>To be added.</remarks>
2222
</Docs>
2323
<Members>
@@ -42,11 +42,11 @@
4242
<Parameter Name="idProvider" Type="System.Func&lt;System.Collections.Generic.IEnumerable&lt;System.Reflection.Metadata.Blob&gt;,System.Reflection.Metadata.BlobContentId&gt;" />
4343
</Parameters>
4444
<Docs>
45-
<param name="tablesAndHeaps">To be added.</param>
46-
<param name="typeSystemRowCounts">To be added.</param>
47-
<param name="entryPoint">To be added.</param>
48-
<param name="idProvider">To be added.</param>
49-
<summary>To be added.</summary>
45+
<param name="tablesAndHeaps">A builder populated with debug metadata entities stored in tables and values stored in heaps. The entities and values are enumerated when serializing the Portable PDB image.</param>
46+
<param name="typeSystemRowCounts">The row counts of all tables that the associated type system metadata contain. Each slot in the array corresponds to a table (<see cref="T:System.Reflection.Metadata.Ecma335.TableIndex" />). The length of the array must be equal <see cref="F:System.Reflection.Metadata.Ecma335.MetadataTokens.TableCount" />.</param>
47+
<param name="entryPoint">An entry point method definition handle.</param>
48+
<param name="idProvider">A function that calculates the ID of content represented as a sequence of blobs. If not specified, a default function that ignores the content and returns a content ID based on the current time is used (<see cref="M:System.Reflection.Metadata.BlobContentId.GetTimeBasedProvider" />). You must specify a deterministic function to produce a deterministic Portable PDB image.</param>
49+
<summary>Creates a builder of a Portable PDB image.</summary>
5050
<remarks>To be added.</remarks>
5151
</Docs>
5252
</Member>
@@ -144,9 +144,9 @@
144144
<Parameter Name="builder" Type="System.Reflection.Metadata.BlobBuilder" />
145145
</Parameters>
146146
<Docs>
147-
<param name="builder">To be added.</param>
148-
<summary>To be added.</summary>
149-
<returns>To be added.</returns>
147+
<param name="builder">The builder to write to.</param>
148+
<summary>Serializes portable PDB content into the given <see cref="T:System.Reflection.Metadata.BlobBuilder" />.</summary>
149+
<returns>The ID of the serialized content.</returns>
150150
<remarks>To be added.</remarks>
151151
</Docs>
152152
</Member>

‎xml/System.Reflection.Metadata.Ecma335/ScalarEncoder.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@
9696
<Parameter Name="value" Type="System.Object" Index="0" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0" />
9797
</Parameters>
9898
<Docs>
99-
<param name="value">To be added.</param>
100-
<summary>To be added.</summary>
99+
<param name="value">A constant of type <see cref="T:System.Boolean" />, <see cref="T:System.Byte" />, <see cref="T:System.SByte" />, <see cref="T:System.Int16" />, <see cref="T:System.UInt16" />, <see cref="T:System.Int32" />, <see cref="T:System.UInt32" />, <see cref="T:System.Int64" />, <see cref="T:System.UInt64" />, <see cref="T:System.Single" />, <see cref="T:System.Double" />, <see cref="T:System.Char" /> (encoded as a two-byte Unicode character), <see cref="T:System.String" /> (encoded as SerString), or <see cref="T:System.Enum" /> (encoded as the underlying integer value).</param>
100+
<summary>Encodes a constant literal.</summary>
101101
<remarks>To be added.</remarks>
102102
</Docs>
103103
</Member>
@@ -121,7 +121,7 @@
121121
</ReturnValue>
122122
<Parameters />
123123
<Docs>
124-
<summary>To be added.</summary>
124+
<summary>Encodes a <see langword="null" /> literal of type <see cref="T:System.Array" />.</summary>
125125
<remarks>To be added.</remarks>
126126
</Docs>
127127
</Member>
@@ -147,8 +147,8 @@
147147
<Parameter Name="serializedTypeName" Type="System.String" Index="0" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0" />
148148
</Parameters>
149149
<Docs>
150-
<param name="serializedTypeName">To be added.</param>
151-
<summary>To be added.</summary>
150+
<param name="serializedTypeName">The name of the type, or <see langword="null" />.</param>
151+
<summary>Encodes a literal of type <see cref="T:System.Type" /> (which can possibly be <see langword="null" />).</summary>
152152
<remarks>To be added.</remarks>
153153
</Docs>
154154
</Member>

0 commit comments

Comments
 (0)