Skip to content

Commit a837a23

Browse files
authored
Add auto generated doc (#4098)
1 parent 164fa24 commit a837a23

File tree

108 files changed

+1869
-808
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

108 files changed

+1869
-808
lines changed

xml/System.Reflection.Metadata.Ecma335/EditAndContinueLogEntry.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="EditAndContinueLogEntry" FullName="System.Reflection.Metadata.Ecma335.EditAndContinueLogEntry">
1+
<Type Name="EditAndContinueLogEntry" FullName="System.Reflection.Metadata.Ecma335.EditAndContinueLogEntry">
22
<TypeSignature Language="C#" Value="public struct EditAndContinueLogEntry : IEquatable&lt;System.Reflection.Metadata.Ecma335.EditAndContinueLogEntry&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit EditAndContinueLogEntry extends System.ValueType implements class System.IEquatable`1&lt;valuetype System.Reflection.Metadata.Ecma335.EditAndContinueLogEntry&gt;" />
44
<TypeSignature Language="DocId" Value="T:System.Reflection.Metadata.Ecma335.EditAndContinueLogEntry" />
@@ -125,9 +125,10 @@
125125
<Parameter Name="other" Type="System.Reflection.Metadata.Ecma335.EditAndContinueLogEntry" />
126126
</Parameters>
127127
<Docs>
128-
<param name="other">To be added.</param>
129-
<summary>To be added.</summary>
130-
<returns>To be added.</returns>
128+
<param name="other">An object to compare with this object.</param>
129+
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
130+
<returns>
131+
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
131132
<remarks>To be added.</remarks>
132133
</Docs>
133134
</Member>

xml/System.Reflection.Metadata.Ecma335/LabelHandle.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="LabelHandle" FullName="System.Reflection.Metadata.Ecma335.LabelHandle">
1+
<Type Name="LabelHandle" FullName="System.Reflection.Metadata.Ecma335.LabelHandle">
22
<TypeSignature Language="C#" Value="public struct LabelHandle : IEquatable&lt;System.Reflection.Metadata.Ecma335.LabelHandle&gt;" FrameworkAlternate="net-5.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
33
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit LabelHandle extends System.ValueType implements class System.IEquatable`1&lt;valuetype System.Reflection.Metadata.Ecma335.LabelHandle&gt;" FrameworkAlternate="net-5.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
44
<TypeSignature Language="DocId" Value="T:System.Reflection.Metadata.Ecma335.LabelHandle" FrameworkAlternate="net-5.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
@@ -89,9 +89,10 @@
8989
<Parameter Name="other" Type="System.Reflection.Metadata.Ecma335.LabelHandle" Index="0" FrameworkAlternate="net-5.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
9090
</Parameters>
9191
<Docs>
92-
<param name="other">To be added.</param>
93-
<summary>To be added.</summary>
94-
<returns>To be added.</returns>
92+
<param name="other">An object to compare with this object.</param>
93+
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
94+
<returns>
95+
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
9596
<remarks>To be added.</remarks>
9697
</Docs>
9798
</Member>

xml/System.Reflection.Metadata/AssemblyDefinitionHandle.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="AssemblyDefinitionHandle" FullName="System.Reflection.Metadata.AssemblyDefinitionHandle">
1+
<Type Name="AssemblyDefinitionHandle" FullName="System.Reflection.Metadata.AssemblyDefinitionHandle">
22
<TypeSignature Language="C#" Value="public struct AssemblyDefinitionHandle : IEquatable&lt;System.Reflection.Metadata.AssemblyDefinitionHandle&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit AssemblyDefinitionHandle extends System.ValueType implements class System.IEquatable`1&lt;valuetype System.Reflection.Metadata.AssemblyDefinitionHandle&gt;" />
44
<TypeSignature Language="DocId" Value="T:System.Reflection.Metadata.AssemblyDefinitionHandle" />
@@ -95,9 +95,10 @@
9595
<Parameter Name="other" Type="System.Reflection.Metadata.AssemblyDefinitionHandle" />
9696
</Parameters>
9797
<Docs>
98-
<param name="other">To be added.</param>
99-
<summary>To be added.</summary>
100-
<returns>To be added.</returns>
98+
<param name="other">An object to compare with this object.</param>
99+
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
100+
<returns>
101+
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
101102
<remarks>To be added.</remarks>
102103
</Docs>
103104
</Member>

xml/System.Reflection.Metadata/AssemblyFileHandle.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="AssemblyFileHandle" FullName="System.Reflection.Metadata.AssemblyFileHandle">
1+
<Type Name="AssemblyFileHandle" FullName="System.Reflection.Metadata.AssemblyFileHandle">
22
<TypeSignature Language="C#" Value="public struct AssemblyFileHandle : IEquatable&lt;System.Reflection.Metadata.AssemblyFileHandle&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit AssemblyFileHandle extends System.ValueType implements class System.IEquatable`1&lt;valuetype System.Reflection.Metadata.AssemblyFileHandle&gt;" />
44
<TypeSignature Language="DocId" Value="T:System.Reflection.Metadata.AssemblyFileHandle" />
@@ -95,9 +95,10 @@
9595
<Parameter Name="other" Type="System.Reflection.Metadata.AssemblyFileHandle" />
9696
</Parameters>
9797
<Docs>
98-
<param name="other">To be added.</param>
99-
<summary>To be added.</summary>
100-
<returns>To be added.</returns>
98+
<param name="other">An object to compare with this object.</param>
99+
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
100+
<returns>
101+
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
101102
<remarks>To be added.</remarks>
102103
</Docs>
103104
</Member>

xml/System.Reflection.Metadata/AssemblyFileHandleCollection+Enumerator.xml

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="AssemblyFileHandleCollection+Enumerator" FullName="System.Reflection.Metadata.AssemblyFileHandleCollection+Enumerator">
1+
<Type Name="AssemblyFileHandleCollection+Enumerator" FullName="System.Reflection.Metadata.AssemblyFileHandleCollection+Enumerator">
22
<TypeSignature Language="C#" Value="public struct AssemblyFileHandleCollection.Enumerator : System.Collections.Generic.IEnumerator&lt;System.Reflection.Metadata.AssemblyFileHandle&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class nested public sequential ansi sealed beforefieldinit AssemblyFileHandleCollection/Enumerator extends System.ValueType implements class System.Collections.Generic.IEnumerator`1&lt;valuetype System.Reflection.Metadata.AssemblyFileHandle&gt;, class System.Collections.IEnumerator, class System.IDisposable" />
44
<TypeSignature Language="DocId" Value="T:System.Reflection.Metadata.AssemblyFileHandleCollection.Enumerator" />
@@ -61,8 +61,8 @@
6161
<ReturnType>System.Reflection.Metadata.AssemblyFileHandle</ReturnType>
6262
</ReturnValue>
6363
<Docs>
64-
<summary>To be added.</summary>
65-
<value>To be added.</value>
64+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
65+
<value>The element in the collection at the current position of the enumerator.</value>
6666
<remarks>To be added.</remarks>
6767
</Docs>
6868
</Member>
@@ -93,8 +93,9 @@
9393
</ReturnValue>
9494
<Parameters />
9595
<Docs>
96-
<summary>To be added.</summary>
97-
<returns>To be added.</returns>
96+
<summary>Advances the enumerator to the next element of the collection.</summary>
97+
<returns>
98+
<see langword="true" /> if the enumerator was successfully advanced to the next element; <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
9899
<remarks>To be added.</remarks>
99100
</Docs>
100101
</Member>
@@ -124,9 +125,17 @@
124125
<ReturnType>System.Object</ReturnType>
125126
</ReturnValue>
126127
<Docs>
127-
<summary>To be added.</summary>
128-
<value>To be added.</value>
129-
<remarks>To be added.</remarks>
128+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
129+
<value>The element in the collection at the current position of the enumerator.</value>
130+
<remarks>
131+
<format type="text/markdown"><![CDATA[
132+
133+
## Remarks
134+
135+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Reflection.Metadata.AssemblyFileHandleCollection.Enumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
136+
137+
]]></format>
138+
</remarks>
130139
</Docs>
131140
</Member>
132141
<Member MemberName="System.Collections.IEnumerator.Reset">
@@ -156,8 +165,16 @@
156165
</ReturnValue>
157166
<Parameters />
158167
<Docs>
159-
<summary>To be added.</summary>
160-
<remarks>To be added.</remarks>
168+
<summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
169+
<remarks>
170+
<format type="text/markdown"><![CDATA[
171+
172+
## Remarks
173+
174+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Reflection.Metadata.AssemblyFileHandleCollection.Enumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
175+
176+
]]></format>
177+
</remarks>
161178
</Docs>
162179
</Member>
163180
<Member MemberName="System.IDisposable.Dispose">
@@ -187,8 +204,16 @@
187204
</ReturnValue>
188205
<Parameters />
189206
<Docs>
190-
<summary>To be added.</summary>
191-
<remarks>To be added.</remarks>
207+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
208+
<remarks>
209+
<format type="text/markdown"><![CDATA[
210+
211+
## Remarks
212+
213+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Reflection.Metadata.AssemblyFileHandleCollection.Enumerator> instance is cast to an <xref:System.IDisposable> interface.
214+
215+
]]></format>
216+
</remarks>
192217
</Docs>
193218
</Member>
194219
</Members>

xml/System.Reflection.Metadata/AssemblyFileHandleCollection.xml

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="AssemblyFileHandleCollection" FullName="System.Reflection.Metadata.AssemblyFileHandleCollection">
1+
<Type Name="AssemblyFileHandleCollection" FullName="System.Reflection.Metadata.AssemblyFileHandleCollection">
22
<TypeSignature Language="C#" Value="public struct AssemblyFileHandleCollection : System.Collections.Generic.IEnumerable&lt;System.Reflection.Metadata.AssemblyFileHandle&gt;, System.Collections.Generic.IReadOnlyCollection&lt;System.Reflection.Metadata.AssemblyFileHandle&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit AssemblyFileHandleCollection extends System.ValueType implements class System.Collections.Generic.IEnumerable`1&lt;valuetype System.Reflection.Metadata.AssemblyFileHandle&gt;, class System.Collections.Generic.IReadOnlyCollection`1&lt;valuetype System.Reflection.Metadata.AssemblyFileHandle&gt;, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.Reflection.Metadata.AssemblyFileHandleCollection" />
@@ -70,8 +70,8 @@
7070
<ReturnType>System.Int32</ReturnType>
7171
</ReturnValue>
7272
<Docs>
73-
<summary>To be added.</summary>
74-
<value>To be added.</value>
73+
<summary>Gets the number of elements in the collection.</summary>
74+
<value>The number of elements in the collection.</value>
7575
<remarks>To be added.</remarks>
7676
</Docs>
7777
</Member>
@@ -131,8 +131,8 @@
131131
</ReturnValue>
132132
<Parameters />
133133
<Docs>
134-
<summary>To be added.</summary>
135-
<returns>To be added.</returns>
134+
<summary>Returns an enumerator that iterates through the collection.</summary>
135+
<returns>An enumerator that can be used to iterate through the collection.</returns>
136136
<remarks>To be added.</remarks>
137137
</Docs>
138138
</Member>
@@ -163,9 +163,17 @@
163163
</ReturnValue>
164164
<Parameters />
165165
<Docs>
166-
<summary>To be added.</summary>
167-
<returns>To be added.</returns>
168-
<remarks>To be added.</remarks>
166+
<summary>Returns an enumerator that iterates through a collection.</summary>
167+
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
168+
<remarks>
169+
<format type="text/markdown"><![CDATA[
170+
171+
## Remarks
172+
173+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Reflection.Metadata.AssemblyFileHandleCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
174+
175+
]]></format>
176+
</remarks>
169177
</Docs>
170178
</Member>
171179
</Members>

xml/System.Reflection.Metadata/AssemblyReferenceHandle.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="AssemblyReferenceHandle" FullName="System.Reflection.Metadata.AssemblyReferenceHandle">
1+
<Type Name="AssemblyReferenceHandle" FullName="System.Reflection.Metadata.AssemblyReferenceHandle">
22
<TypeSignature Language="C#" Value="public struct AssemblyReferenceHandle : IEquatable&lt;System.Reflection.Metadata.AssemblyReferenceHandle&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit AssemblyReferenceHandle extends System.ValueType implements class System.IEquatable`1&lt;valuetype System.Reflection.Metadata.AssemblyReferenceHandle&gt;" />
44
<TypeSignature Language="DocId" Value="T:System.Reflection.Metadata.AssemblyReferenceHandle" />
@@ -95,9 +95,10 @@
9595
<Parameter Name="other" Type="System.Reflection.Metadata.AssemblyReferenceHandle" />
9696
</Parameters>
9797
<Docs>
98-
<param name="other">To be added.</param>
99-
<summary>To be added.</summary>
100-
<returns>To be added.</returns>
98+
<param name="other">An object to compare with this object.</param>
99+
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
100+
<returns>
101+
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
101102
<remarks>To be added.</remarks>
102103
</Docs>
103104
</Member>

xml/System.Reflection.Metadata/AssemblyReferenceHandleCollection+Enumerator.xml

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="AssemblyReferenceHandleCollection+Enumerator" FullName="System.Reflection.Metadata.AssemblyReferenceHandleCollection+Enumerator">
1+
<Type Name="AssemblyReferenceHandleCollection+Enumerator" FullName="System.Reflection.Metadata.AssemblyReferenceHandleCollection+Enumerator">
22
<TypeSignature Language="C#" Value="public struct AssemblyReferenceHandleCollection.Enumerator : System.Collections.Generic.IEnumerator&lt;System.Reflection.Metadata.AssemblyReferenceHandle&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class nested public sequential ansi sealed beforefieldinit AssemblyReferenceHandleCollection/Enumerator extends System.ValueType implements class System.Collections.Generic.IEnumerator`1&lt;valuetype System.Reflection.Metadata.AssemblyReferenceHandle&gt;, class System.Collections.IEnumerator, class System.IDisposable" />
44
<TypeSignature Language="DocId" Value="T:System.Reflection.Metadata.AssemblyReferenceHandleCollection.Enumerator" />
@@ -61,8 +61,8 @@
6161
<ReturnType>System.Reflection.Metadata.AssemblyReferenceHandle</ReturnType>
6262
</ReturnValue>
6363
<Docs>
64-
<summary>To be added.</summary>
65-
<value>To be added.</value>
64+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
65+
<value>The element in the collection at the current position of the enumerator.</value>
6666
<remarks>To be added.</remarks>
6767
</Docs>
6868
</Member>
@@ -93,8 +93,9 @@
9393
</ReturnValue>
9494
<Parameters />
9595
<Docs>
96-
<summary>To be added.</summary>
97-
<returns>To be added.</returns>
96+
<summary>Advances the enumerator to the next element of the collection.</summary>
97+
<returns>
98+
<see langword="true" /> if the enumerator was successfully advanced to the next element; <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
9899
<remarks>To be added.</remarks>
99100
</Docs>
100101
</Member>
@@ -124,9 +125,17 @@
124125
<ReturnType>System.Object</ReturnType>
125126
</ReturnValue>
126127
<Docs>
127-
<summary>To be added.</summary>
128-
<value>To be added.</value>
129-
<remarks>To be added.</remarks>
128+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
129+
<value>The element in the collection at the current position of the enumerator.</value>
130+
<remarks>
131+
<format type="text/markdown"><![CDATA[
132+
133+
## Remarks
134+
135+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Reflection.Metadata.AssemblyReferenceHandleCollection.Enumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
136+
137+
]]></format>
138+
</remarks>
130139
</Docs>
131140
</Member>
132141
<Member MemberName="System.Collections.IEnumerator.Reset">
@@ -156,8 +165,16 @@
156165
</ReturnValue>
157166
<Parameters />
158167
<Docs>
159-
<summary>To be added.</summary>
160-
<remarks>To be added.</remarks>
168+
<summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
169+
<remarks>
170+
<format type="text/markdown"><![CDATA[
171+
172+
## Remarks
173+
174+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Reflection.Metadata.AssemblyReferenceHandleCollection.Enumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
175+
176+
]]></format>
177+
</remarks>
161178
</Docs>
162179
</Member>
163180
<Member MemberName="System.IDisposable.Dispose">
@@ -187,8 +204,16 @@
187204
</ReturnValue>
188205
<Parameters />
189206
<Docs>
190-
<summary>To be added.</summary>
191-
<remarks>To be added.</remarks>
207+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
208+
<remarks>
209+
<format type="text/markdown"><![CDATA[
210+
211+
## Remarks
212+
213+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Reflection.Metadata.AssemblyReferenceHandleCollection.Enumerator> instance is cast to an <xref:System.IDisposable> interface.
214+
215+
]]></format>
216+
</remarks>
192217
</Docs>
193218
</Member>
194219
</Members>

0 commit comments

Comments
 (0)