Skip to content

Commit cc4a3d4

Browse files
carlossanlopRon Petrusha
carlossanlop
authored and
Ron Petrusha
committed
Automatically port Reflection.Metadata E-L APIs (#3201)
* Automatically port Reflection.Metadata E-L APIs * Update EntityHandle.xml * Update ExportedTypeHandleCollection.xml * Added links to ECMA-335 Standard * Update GenericParameterConstraint.xml * Update Handle.xml * Update ImportScope.xml * Update LocalConstant.xml * Update ImportScope.xml * Update LocalConstant.xml * Update LocalScope.xml * Update LocalVariable.xml * typo
1 parent c955cc6 commit cc4a3d4

12 files changed

+145
-31
lines changed

‎xml/System.Reflection.Metadata/EntityHandle.xml‎

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,16 @@
2828
</Attribute>
2929
</Attributes>
3030
<Docs>
31-
<summary>To be added.</summary>
32-
<remarks>To be added.</remarks>
31+
<summary>Represents a metadata entity (such as a type reference, type definition, type specification, method definition, or custom attribute).</summary>
32+
<remarks>
33+
<format type="text/markdown"><![CDATA[
34+
35+
## Remarks
36+
37+
Use <xref:System.Reflection.Metadata.EntityHandle> to store multiple kinds of entity handles. It has a smaller memory footprint than <xref:System.Reflection.Metadata.Handle>.
38+
39+
]]></format>
40+
</remarks>
3341
</Docs>
3442
<Members>
3543
<Member MemberName="AssemblyDefinition">
@@ -81,9 +89,9 @@
8189
<Parameter Name="obj" Type="System.Object" />
8290
</Parameters>
8391
<Docs>
84-
<param name="obj">To be added.</param>
85-
<summary>To be added.</summary>
86-
<returns>To be added.</returns>
92+
<param name="obj">The object to compare with the current instance.</param>
93+
<summary>Returns a value that indicates whether the current instance and the specified object are equal.</summary>
94+
<returns><see langword="true" /> if <paramref name="obj" /> is an <see cref="T:System.Reflection.Metadata.EntityHandle" /> and is equal to the current instance; otherwise, <see langword="false" />.</returns>
8795
<remarks>To be added.</remarks>
8896
</Docs>
8997
</Member>
@@ -114,9 +122,9 @@
114122
<Parameter Name="other" Type="System.Reflection.Metadata.EntityHandle" />
115123
</Parameters>
116124
<Docs>
117-
<param name="other">To be added.</param>
118-
<summary>To be added.</summary>
119-
<returns>To be added.</returns>
125+
<param name="other">The value to compare with the current instance.</param>
126+
<summary>Returns a value that indicates whether the current instance and the specified <see cref="T:System.Reflection.Metadata.EntityHandle" /> are equal.</summary>
127+
<returns><see langword="true" /> if the current instance and <paramref name="other" /> are equal; otherwise, <see langword="false" />.</returns>
120128
<remarks>To be added.</remarks>
121129
</Docs>
122130
</Member>
@@ -142,8 +150,8 @@
142150
</ReturnValue>
143151
<Parameters />
144152
<Docs>
145-
<summary>To be added.</summary>
146-
<returns>To be added.</returns>
153+
<summary>Returns the hash code for this instance.</summary>
154+
<returns>The hash code for this instance.</returns>
147155
<remarks>To be added.</remarks>
148156
</Docs>
149157
</Member>

‎xml/System.Reflection.Metadata/ExportedTypeHandleCollection.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
</Attribute>
3838
</Attributes>
3939
<Docs>
40-
<summary>To be added.</summary>
40+
<summary>Represents a collection of <see cref="T:System.Reflection.Metadata.TypeReferenceHandle" /> instances.</summary>
4141
<remarks>To be added.</remarks>
4242
</Docs>
4343
<Members>

‎xml/System.Reflection.Metadata/GenericParameter.xml‎

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,15 @@
5151
<Docs>
5252
<summary>Gets the attributes specifying variance and constraints.</summary>
5353
<value>To be added.</value>
54-
<remarks>To be added.</remarks>
54+
<remarks>
55+
<format type="text/markdown"><![CDATA[
56+
57+
## Remarks
58+
59+
Corresponds to the `Flags` field of the `GenericParam` table in the [ECMA-335 Standard](https://www.ecma-international.org/publications/standards/Ecma-335.htm).
60+
61+
]]></format>
62+
</remarks>
5563
</Docs>
5664
</Member>
5765
<Member MemberName="GetConstraints">
@@ -131,7 +139,15 @@
131139
<Docs>
132140
<summary>Gets the zero-based index of the parameter within the declaring generic type or method declaration.</summary>
133141
<value>To be added.</value>
134-
<remarks>To be added.</remarks>
142+
<remarks>
143+
<format type="text/markdown"><![CDATA[
144+
145+
## Remarks
146+
147+
Corresponds to the `Number` field of the `GenericParam` table in the [ECMA-335 Standard](https://www.ecma-international.org/publications/standards/Ecma-335.htm).
148+
149+
]]></format>
150+
</remarks>
135151
</Docs>
136152
</Member>
137153
<Member MemberName="Name">
@@ -157,7 +173,15 @@
157173
<Docs>
158174
<summary>Gets the name of the generic parameter.</summary>
159175
<value>To be added.</value>
160-
<remarks>To be added.</remarks>
176+
<remarks>
177+
<format type="text/markdown"><![CDATA[
178+
179+
## Remarks
180+
181+
Corresponds to the `Name` field of the `GenericParam` table in the [ECMA-335 Standard](https://www.ecma-international.org/publications/standards/Ecma-335.htm).
182+
183+
]]></format>
184+
</remarks>
161185
</Docs>
162186
</Member>
163187
<Member MemberName="Parent">
@@ -183,7 +207,15 @@
183207
<Docs>
184208
<summary>Gets a <see cref="T:System.Reflection.Metadata.TypeDefinitionHandle" /> or <see cref="T:System.Reflection.Metadata.MethodDefinitionHandle" /> that represents the parent of this generic parameter.</summary>
185209
<value>To be added.</value>
186-
<remarks>To be added.</remarks>
210+
<remarks>
211+
<format type="text/markdown"><![CDATA[
212+
213+
## Remarks
214+
215+
Corresponds to the `Owner` field of the `GenericParam` table in the [ECMA-335 Standard](https://www.ecma-international.org/publications/standards/Ecma-335.htm).
216+
217+
]]></format>
218+
</remarks>
187219
</Docs>
188220
</Member>
189221
</Members>

‎xml/System.Reflection.Metadata/GenericParameterConstraint.xml‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,15 @@
7878
<Docs>
7979
<summary>Gets the constrained <see cref="T:System.Reflection.Metadata.GenericParameterHandle" />.</summary>
8080
<value>To be added.</value>
81-
<remarks>To be added.</remarks>
81+
<remarks>
82+
<format type="text/markdown"><![CDATA[
83+
84+
## Remarks
85+
86+
Corresponds to the `Owner` field of the `GenericParamConstraint` table in the [ECMA-335 Standard](https://www.ecma-international.org/publications/standards/Ecma-335.htm).
87+
88+
]]></format>
89+
</remarks>
8290
</Docs>
8391
</Member>
8492
<Member MemberName="Type">
@@ -106,7 +114,15 @@
106114
specifying from which type this generic parameter is constrained to derive,
107115
or which interface this generic parameter is constrained to implement.</summary>
108116
<value>An <see cref="T:System.Reflection.Metadata.EntityHandle" /> instance.</value>
109-
<remarks>To be added.</remarks>
117+
<remarks>
118+
<format type="text/markdown"><![CDATA[
119+
120+
## Remarks
121+
122+
Corresponds to the `Constraint` field of the `GenericParamConstraint` table in the [ECMA-335 Standard](https://www.ecma-international.org/publications/standards/Ecma-335.htm).
123+
124+
]]></format>
125+
</remarks>
110126
</Docs>
111127
</Member>
112128
</Members>

‎xml/System.Reflection.Metadata/GenericParameterConstraintHandleCollection.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
</Attribute>
4444
</Attributes>
4545
<Docs>
46-
<summary>To be added.</summary>
46+
<summary>Represents a collection of constraints of a generic type parameter.</summary>
4747
<remarks>To be added.</remarks>
4848
</Docs>
4949
<Members>

‎xml/System.Reflection.Metadata/GenericParameterHandleCollection.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
</Attribute>
4444
</Attributes>
4545
<Docs>
46-
<summary>To be added.</summary>
46+
<summary>Represents a collection of generic type parameters of a method or type.</summary>
4747
<remarks>To be added.</remarks>
4848
</Docs>
4949
<Members>

‎xml/System.Reflection.Metadata/Handle.xml‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,16 @@
2828
</Attribute>
2929
</Attributes>
3030
<Docs>
31-
<summary>To be added.</summary>
32-
<remarks>To be added.</remarks>
31+
<summary>Represents any metadata entity (such as a type reference, a type definition, a type specification, a method definition, or a custom attribute) or value (a string, blob, guid, or user string).</summary>
32+
<remarks>
33+
<format type="text/markdown"><![CDATA[
34+
35+
## Remarks
36+
37+
Use `Handle` to store multiple kinds of handles.
38+
39+
]]></format>
40+
</remarks>
3341
</Docs>
3442
<Members>
3543
<Member MemberName="AssemblyDefinition">

‎xml/System.Reflection.Metadata/HandleComparer.xml‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,15 @@
6868
<param name="y">The second entity handle to compare.</param>
6969
<summary>Compares two entity handles.</summary>
7070
<returns>Zero if the two entity handles are equal, and a non-zero value of they are not.</returns>
71-
<remarks>To be added.</remarks>
71+
<remarks>
72+
<format type="text/markdown"><![CDATA[
73+
74+
## Remarks
75+
76+
Returns 0 if and only if <xref:System.Reflection.Metadata.HandleComparer.Equals(System.Reflection.Metadata.EntityHandle,System.Reflection.Metadata.EntityHandle)> returns `true`.
77+
78+
]]></format>
79+
</remarks>
7280
</Docs>
7381
</Member>
7482
<Member MemberName="Compare">
@@ -103,7 +111,17 @@
103111
<param name="y">The second handle to compare.</param>
104112
<summary>Compares two handles.</summary>
105113
<returns>Zero if the two handles are equal, and a non-zero value if they are not.</returns>
106-
<remarks>To be added.</remarks>
114+
<remarks>
115+
<format type="text/markdown"><![CDATA[
116+
117+
## Remarks
118+
119+
The order of handles that differ in kind and are not <xref:System.Reflection.Metadata.EntityHandle> is undefined.
120+
121+
Returns 0 if and only if <xref:System.Reflection.Metadata.HandleComparer.Equals(System.Reflection.Metadata.Handle,System.Reflection.Metadata.Handle)> returns `true`.
122+
123+
]]></format>
124+
</remarks>
107125
</Docs>
108126
</Member>
109127
<Member MemberName="Default">

‎xml/System.Reflection.Metadata/ImportScope.xml‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,16 @@
2323
</Attribute>
2424
</Attributes>
2525
<Docs>
26-
<summary>To be added.</summary>
27-
<remarks>To be added.</remarks>
26+
<summary>Provides information about the lexical scope within which a group of imports are available. This information is stored in debug metadata.</summary>
27+
<remarks>
28+
<format type="text/markdown"><![CDATA[
29+
30+
## Remarks
31+
32+
See [ImportScope Table" 0x35](https://github.com/dotnet/corefx/blob/master/src/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#importscope-table-0x35) for more information.
33+
34+
]]></format>
35+
</remarks>
2836
</Docs>
2937
<Members>
3038
<Member MemberName="GetImports">

‎xml/System.Reflection.Metadata/LocalConstant.xml‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,16 @@
2323
</Attribute>
2424
</Attributes>
2525
<Docs>
26-
<summary>To be added.</summary>
27-
<remarks>To be added.</remarks>
26+
<summary>Provides information about local constants. This information is stored in debug metadata.</summary>
27+
<remarks>
28+
<format type="text/markdown"><![CDATA[
29+
30+
## Remarks
31+
32+
See [LocalConstant Table: 0x34](https://github.com/dotnet/corefx/blob/master/src/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#localconstant-table-0x34).
33+
34+
]]></format>
35+
</remarks>
2836
</Docs>
2937
<Members>
3038
<Member MemberName="Name">

0 commit comments

Comments
 (0)