Skip to content

Commit 891ff66

Browse files
carlossanlopBillWagner
carlossanlop
and
BillWagner
authored
Automatic port of System.Reflection.Metadata.Ecma335 (dotnet#3944)
* Automatic port of System.Reflection.Metadata.Ecma335 * Apply suggestions from code review Co-Authored-By: Bill Wagner <[email protected]> Co-authored-by: Bill Wagner <[email protected]>
1 parent e9ba72a commit 891ff66

File tree

8 files changed

+216
-175
lines changed

8 files changed

+216
-175
lines changed

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,11 @@
102102
<Parameter Name="lowerBounds" Type="System.Collections.Immutable.ImmutableArray&lt;System.Int32&gt;" Index="2" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
103103
</Parameters>
104104
<Docs>
105-
<param name="rank">To be added.</param>
106-
<param name="sizes">To be added.</param>
107-
<param name="lowerBounds">To be added.</param>
108-
<summary>To be added.</summary>
105+
<param name="rank">The number of dimensions in the array (shall be 1 or more).</param>
106+
<param name="sizes">Dimension sizes. The array may be shorter than <paramref name="rank" /> but not longer.</param>
107+
<param name="lowerBounds">Dimension lower bounds, or default(<see cref="T:System.Collections.Immutable.ImmutableArray`1" />) to set all <paramref name="rank" /> lower bounds to 0.
108+
The array may be shorter than <paramref name="rank" /> but not longer.</param>
109+
<summary>Encodes array shape.</summary>
109110
<remarks>To be added.</remarks>
110111
</Docs>
111112
</Member>

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

Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,9 @@
101101
<Parameter Name="namedArguments" Type="System.Action&lt;System.Reflection.Metadata.Ecma335.CustomAttributeNamedArgumentsEncoder&gt;" Index="1" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
102102
</Parameters>
103103
<Docs>
104-
<param name="fixedArguments">To be added.</param>
105-
<param name="namedArguments">To be added.</param>
106-
<summary>To be added.</summary>
104+
<param name="fixedArguments">Called first, to encode fixed arguments.</param>
105+
<param name="namedArguments">Called second, to encode named arguments.</param>
106+
<summary>Encodes custom attribute signature blob.</summary>
107107
<remarks>To be added.</remarks>
108108
</Docs>
109109
</Member>
@@ -131,9 +131,10 @@
131131
<Parameter Name="namedArguments" Type="System.Reflection.Metadata.Ecma335.CustomAttributeNamedArgumentsEncoder" RefType="out" Index="1" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
132132
</Parameters>
133133
<Docs>
134-
<param name="fixedArguments">To be added.</param>
135-
<param name="namedArguments">To be added.</param>
136-
<summary>To be added.</summary>
134+
<param name="fixedArguments">Use first, to encode fixed arguments.</param>
135+
<param name="namedArguments">Use second, to encode named arguments.</param>
136+
<summary>Encodes custom attribute signature blob.
137+
Returns a pair of encoders that must be used in the order they appear in the parameter list.</summary>
137138
<remarks>To be added.</remarks>
138139
</Docs>
139140
</Member>
@@ -158,8 +159,8 @@
158159
</ReturnValue>
159160
<Parameters />
160161
<Docs>
161-
<summary>To be added.</summary>
162-
<returns>To be added.</returns>
162+
<summary>Encodes field signature blob.</summary>
163+
<returns>Encoder of the field type.</returns>
163164
<remarks>To be added.</remarks>
164165
</Docs>
165166
</Member>
@@ -186,9 +187,9 @@
186187
<Parameter Name="variableCount" Type="System.Int32" Index="0" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
187188
</Parameters>
188189
<Docs>
189-
<param name="variableCount">To be added.</param>
190-
<summary>To be added.</summary>
191-
<returns>To be added.</returns>
190+
<param name="variableCount">Number of local variables.</param>
191+
<summary>Encodes local variable signature.</summary>
192+
<returns>Encoder of a sequence of local variables.</returns>
192193
<remarks>To be added.</remarks>
193194
</Docs>
194195
</Member>
@@ -216,11 +217,12 @@
216217
<Parameter Name="isInstanceMethod" Type="System.Boolean" Index="2" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
217218
</Parameters>
218219
<Docs>
219-
<param name="convention">To be added.</param>
220-
<param name="genericParameterCount">To be added.</param>
221-
<param name="isInstanceMethod">To be added.</param>
222-
<summary>To be added.</summary>
223-
<returns>To be added.</returns>
220+
<param name="convention">Calling convention.</param>
221+
<param name="genericParameterCount">Number of generic parameters.</param>
222+
<param name="isInstanceMethod">
223+
<see langword="true" /> to encode an instance method signature, <see langword="false" /> to encode a static method signature.</param>
224+
<summary>Encodes method signature blob.</summary>
225+
<returns>An encoder of the rest of the signature including return value and parameters.</returns>
224226
<remarks>To be added.</remarks>
225227
</Docs>
226228
</Member>
@@ -247,9 +249,9 @@
247249
<Parameter Name="genericArgumentCount" Type="System.Int32" Index="0" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
248250
</Parameters>
249251
<Docs>
250-
<param name="genericArgumentCount">To be added.</param>
251-
<summary>To be added.</summary>
252-
<returns>To be added.</returns>
252+
<param name="genericArgumentCount">Number of generic arguments.</param>
253+
<summary>Encodes method specification signature blob.</summary>
254+
<returns>Encoder of generic arguments.</returns>
253255
<remarks>To be added.</remarks>
254256
</Docs>
255257
</Member>
@@ -276,9 +278,9 @@
276278
<Parameter Name="argumentCount" Type="System.Int32" Index="0" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
277279
</Parameters>
278280
<Docs>
279-
<param name="argumentCount">To be added.</param>
280-
<summary>To be added.</summary>
281-
<returns>To be added.</returns>
281+
<param name="argumentCount">Number of arguments in the set.</param>
282+
<summary>Encodes permission set arguments.</summary>
283+
<returns>Encoder of the arguments of the set.</returns>
282284
<remarks>To be added.</remarks>
283285
</Docs>
284286
</Member>
@@ -305,9 +307,9 @@
305307
<Parameter Name="attributeCount" Type="System.Int32" Index="0" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
306308
</Parameters>
307309
<Docs>
308-
<param name="attributeCount">To be added.</param>
309-
<summary>To be added.</summary>
310-
<returns>To be added.</returns>
310+
<param name="attributeCount">Number of attributes in the set.</param>
311+
<summary>Encodes a permission set blob.</summary>
312+
<returns>Permission set encoder.</returns>
311313
<remarks>To be added.</remarks>
312314
</Docs>
313315
</Member>
@@ -333,9 +335,10 @@
333335
<Parameter Name="isInstanceProperty" Type="System.Boolean" Index="0" FrameworkAlternate="netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
334336
</Parameters>
335337
<Docs>
336-
<param name="isInstanceProperty">To be added.</param>
337-
<summary>To be added.</summary>
338-
<returns>To be added.</returns>
338+
<param name="isInstanceProperty">
339+
<see langword="true" /> to encode an instance property signature, <see langword="false" /> to encode a static property signature.</param>
340+
<summary>Encodes property signature blob.</summary>
341+
<returns>An encoder of the rest of the signature including return value and parameters, which has the same structure as method signature.</returns>
339342
<remarks>To be added.</remarks>
340343
</Docs>
341344
</Member>
@@ -360,8 +363,8 @@
360363
</ReturnValue>
361364
<Parameters />
362365
<Docs>
363-
<summary>To be added.</summary>
364-
<returns>To be added.</returns>
366+
<summary>Encodes type specification signature.</summary>
367+
<returns>Type encoder of the structured type represented by the type specification (it shall not encode a primitive type).</returns>
365368
<remarks>To be added.</remarks>
366369
</Docs>
367370
</Member>

0 commit comments

Comments
 (0)