Automatically port Reflection.Metadata.Ecma335 Method* APIs (#3211)

* Automatically port Reflection.Metadata.Ecma335 Method* APIs

* suggestions by rpetrusha

Co-Authored-By: Ron Petrusha <[email protected]>

* Disambiguate constructors

* Type descriptions

Author: carlossanlop

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

@@ -21,7 +21,7 @@
     </Attribute>
   </Attributes>
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Defines method body attributes.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -45,7 +45,7 @@
       </ReturnValue>
       <MemberValue>1</MemberValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Initializes any locals the method defines to zero and dynamically allocates local memory.</summary>
       </Docs>
     </Member>
     <Member MemberName="None">
@@ -68,7 +68,7 @@
       </ReturnValue>
       <MemberValue>0</MemberValue>
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Performs no local memory initialization.</summary>
       </Docs>
     </Member>
   </Members>

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

@@ -22,7 +22,7 @@
     </Attribute>
   </Attributes>
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Describes a method body. This class is meant to used along with the <see cref="T:System.Reflection.Metadata.Ecma335.MethodBodyStreamEncoder" /> class.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -45,8 +45,8 @@
         <ReturnType>System.Reflection.Metadata.Ecma335.ExceptionRegionEncoder</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <summary>Gets an encoder object that can be used to encode exception regions to the method body.</summary>
+        <value>An exception region encoder instance.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -69,8 +69,8 @@
         <ReturnType>System.Reflection.Metadata.Blob</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <summary>Gets a blob reserved for instructions.</summary>
+        <value>A blob reserved for instructions.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -93,8 +93,8 @@
         <ReturnType>System.Int32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <summary>Gets the offset of the encoded method body in the method body stream.</summary>
+        <value>The offset of the encoded method body in the method body stream.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

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

@@ -22,7 +22,7 @@
     </Attribute>
   </Attributes>
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Provides an encoder for a method body stream.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -75,12 +75,12 @@
         <Parameter Name="attributes" Type="System.Reflection.Metadata.Ecma335.MethodBodyAttributes" />
       </Parameters>
       <Docs>
-        <param name="instructionEncoder">To be added.</param>
-        <param name="maxStack">To be added.</param>
-        <param name="localVariablesSignature">To be added.</param>
-        <param name="attributes">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="instructionEncoder">The instruction encoder.</param>
+        <param name="maxStack">The maximum stack size.</param>
+        <param name="localVariablesSignature">The local variables' signature handle.</param>
+        <param name="attributes">The method body attributes.</param>
+        <summary>Encodes a method body and adds it to the method body stream.</summary>
+        <returns>The offset of the encoded body within the method body stream.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -106,13 +106,13 @@
         <Parameter Name="hasDynamicStackAllocation" Type="System.Boolean" Index="4" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0" />
       </Parameters>
       <Docs>
-        <param name="instructionEncoder">To be added.</param>
-        <param name="maxStack">To be added.</param>
-        <param name="localVariablesSignature">To be added.</param>
-        <param name="attributes">To be added.</param>
-        <param name="hasDynamicStackAllocation">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="instructionEncoder">The instruction encoder.</param>
+        <param name="maxStack">The maximum stack size.</param>
+        <param name="localVariablesSignature">The local variables' signature handle.</param>
+        <param name="attributes">The method body attributes.</param>
+        <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>
+        <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>
+        <returns>The offset of the encoded body within the method body stream.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -145,14 +145,14 @@
         <Parameter Name="attributes" Type="System.Reflection.Metadata.Ecma335.MethodBodyAttributes" />
       </Parameters>
       <Docs>
-        <param name="codeSize">To be added.</param>
-        <param name="maxStack">To be added.</param>
-        <param name="exceptionRegionCount">To be added.</param>
-        <param name="hasSmallExceptionRegions">To be added.</param>
-        <param name="localVariablesSignature">To be added.</param>
-        <param name="attributes">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="codeSize">The number of bytes to be reserved for instructions.</param>
+        <param name="maxStack">The maximum stack size.</param>
+        <param name="exceptionRegionCount">The number of exception regions.</param>
+        <param name="hasSmallExceptionRegions"><see langword="true" /> if the exception regions should be encoded in small format; <see langword="false" /> otherwise.</param>
+        <param name="localVariablesSignature">The local variables' signature handle.</param>
+        <param name="attributes">The method body attributes.</param>
+        <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>
+        <returns>The offset of the encoded body within the method body stream.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -181,15 +181,15 @@
         <Parameter Name="hasDynamicStackAllocation" Type="System.Boolean" Index="6" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0" />
       </Parameters>
       <Docs>
-        <param name="codeSize">To be added.</param>
-        <param name="maxStack">To be added.</param>
-        <param name="exceptionRegionCount">To be added.</param>
-        <param name="hasSmallExceptionRegions">To be added.</param>
-        <param name="localVariablesSignature">To be added.</param>
-        <param name="attributes">To be added.</param>
-        <param name="hasDynamicStackAllocation">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="codeSize">The number of bytes to be reserved for instructions.</param>
+        <param name="maxStack">The maximum stack size.</param>
+        <param name="exceptionRegionCount">The number of exception regions.</param>
+        <param name="hasSmallExceptionRegions"><see langword="true" /> if the exception regions should be encoded in small format; <see langword="false" /> otherwise.</param>
+        <param name="localVariablesSignature">The local variables' signature handle.</param>
+        <param name="attributes">The method body attributes.</param>
+        <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>
+        <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>
+        <returns>The offset of the encoded body within the method body stream.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

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

@@ -22,7 +22,7 @@
     </Attribute>
   </Attributes>
   <Docs>
-    <summary>To be added.</summary>
+    <summary>Provides an encoder for method signatures.</summary>
     <remarks>To be added.</remarks>
   </Docs>
   <Members>
@@ -124,10 +124,10 @@
         <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" />
       </Parameters>
       <Docs>
-        <param name="parameterCount">To be added.</param>
-        <param name="returnType">To be added.</param>
-        <param name="parameters">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="parameterCount">The number of parameters.</param>
+        <param name="returnType">The method that is called first to encode the return type.</param>
+        <param name="parameters">The method that is called second to encode the parameters.</param>
+        <summary>Encodes the provided return type and parameters.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -155,10 +155,10 @@
         <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" />
       </Parameters>
       <Docs>
-        <param name="parameterCount">To be added.</param>
-        <param name="returnType">To be added.</param>
-        <param name="parameters">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="parameterCount">The number of parameters.</param>
+        <param name="returnType">The method that is called first to encode the return types.</param>
+        <param name="parameters">The method that is called second to encode the parameters.</param>
+        <summary>Encodes the provided return type and parameters, which must be used in the order they appear in the parameter list.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>