Add Reflection.Emit missing docs (#9221)

* Add Reflection.Emit missing docs * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]>
dotnet · Aug 29, 2023 · ed9c008 · ed9c008
1 parent 695b963
commit ed9c008
Show file tree

Hide file tree

Showing 12 changed files with 310 additions and 307 deletions.
diff --git a/xml/System.Reflection.Emit/AssemblyBuilder.xml b/xml/System.Reflection.Emit/AssemblyBuilder.xml
@@ -157,8 +157,8 @@ The following code example shows how to define and use a dynamic assembly. The e
       </AssemblyInfo>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <summary>Initializes a new instance of the <see cref="T:System.Reflection.Emit.AssemblyBuilder" /> class.</summary>
+        <remarks>This constructor is invoked by derived classes.</remarks>
       </Docs>
     </Member>
     <MemberGroup MemberName="AddResourceFile">
@@ -954,10 +954,10 @@ The following code example shows how to define and use a dynamic assembly. The e
         <Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="name">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="name">The name of the dynamic module.</param>
+        <summary>When overridden in a derived class, defines a dynamic module in this assembly.</summary>
+        <returns>A <see cref="T:System.Reflection.Emit.ModuleBuilder" /> representing the defined dynamic module.</returns>
+        <remarks>.NET Core supports only one module.</remarks>
       </Docs>
     </Member>
     <MemberGroup MemberName="DefineResource">
@@ -1801,10 +1801,10 @@ The following code example shows how to define and use a dynamic assembly. The e
         <Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="name">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="name">The name of the requested dynamic module.</param>
+        <summary>When overridden in a derived class, returns the dynamic module with the specified name.</summary>
+        <returns>A <see cref="T:System.Reflection.Emit.ModuleBuilder" /> representing the requested dynamic module.</returns>
+        <remarks>.NET Core supports only one module.</remarks>
       </Docs>
     </Member>
     <Member MemberName="GetExportedTypes">
@@ -3446,9 +3446,9 @@ For information on how to format `binaryAttribute`, see the metadata specificati
         <Parameter Name="binaryAttribute" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="con">To be added.</param>
-        <param name="binaryAttribute">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="con">The constructor for the custom attribute.</param>
+        <param name="binaryAttribute">A <see cref="T:System.ReadOnlySpan`1" /> of bytes representing the attribute.</param>
+        <summary>When overridden in a derived class, sets a custom attribute on this assembly.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

diff --git a/xml/System.Reflection.Emit/ConstructorBuilder.xml b/xml/System.Reflection.Emit/ConstructorBuilder.xml
@@ -123,7 +123,7 @@
       <Parameters />
       <Docs>
         <summary>Initializes a new instance of the <see cref="T:System.Reflection.Emit.ConstructorBuilder" /> class.</summary>
-        <remarks>To be added.</remarks>
+        <remarks>This constructor is invoked by derived classes.</remarks>
       </Docs>
     </Member>
     <Member MemberName="AddDeclarativeSecurity">
@@ -436,11 +436,11 @@
         <Parameter Name="strParamName" Type="System.String" Index="2" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="iSequence">To be added.</param>
-        <param name="attributes">To be added.</param>
-        <param name="strParamName">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="iSequence">The position of the parameter in the parameter list. Parameters are indexed beginning with the number 1 for the first parameter.</param>
+        <param name="attributes">The attributes of the parameter.</param>
+        <param name="strParamName">The name of the parameter. The name can be the <see langword="null" /> string.</param>
+        <summary>When overridden in a derived class, defines a parameter of this constructor.</summary>
+        <returns>A <see cref="T:System.Reflection.Emit.ParameterBuilder" /> that represents the new parameter of this constructor.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -707,9 +707,9 @@
         <Parameter Name="streamSize" Type="System.Int32" Index="0" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="streamSize">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="streamSize">The size of the IL stream, in bytes.</param>
+        <summary>When overridden in a derived class, gets an <see cref="T:System.Reflection.Emit.ILGenerator" /> that can be used to emit a method body for this constructor.</summary>
+        <returns>An <see cref="T:System.Reflection.Emit.ILGenerator" /> for this constructor.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -967,8 +967,8 @@
         <ReturnType>System.Boolean</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <summary>When overridden in a derived class, gets or sets a value that indicates whether the local variables in this constructor should be zero-initialized.</summary>
+        <value><see langword="true" /> if the local variables in this constructor are initialized to 0; otherwise, <see langword="false" />.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -1654,9 +1654,9 @@ For information on how to format `binaryAttribute`, see the metadata specificati
         <Parameter Name="binaryAttribute" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="con">To be added.</param>
-        <param name="binaryAttribute">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="con">The constructor for the custom attribute.</param>
+        <param name="binaryAttribute">A <see cref="T:System.ReadOnlySpan`1" /> of bytes representing the attribute.</param>
+        <summary>When overridden in a derived class, sets a custom attribute on this constructor.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -1736,8 +1736,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
         <Parameter Name="attributes" Type="System.Reflection.MethodImplAttributes" Index="0" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="attributes">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="attributes">A bitwise combination of the enumeration values that specifies how the method is implemented.</param>
+        <summary>When overridden in a derived class, sets the method implementation flags for this constructor.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

diff --git a/xml/System.Reflection.Emit/EnumBuilder.xml b/xml/System.Reflection.Emit/EnumBuilder.xml
@@ -129,8 +129,8 @@
       </AssemblyInfo>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <summary>Initializes a new instance of the <see cref="T:System.Reflection.Emit.EnumBuilder" /> class.</summary>
+        <remarks>This constructor is invoked by derived classes.</remarks>
       </Docs>
     </Member>
     <Member MemberName="Assembly">
@@ -472,8 +472,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <summary>When overridden in a derived class, gets a <see cref="T:System.Reflection.TypeInfo" /> object that represents this enumeration.</summary>
+        <returns>A <see cref="T:System.Reflection.TypeInfo" /> object that represents this enumeration.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -659,10 +659,10 @@
         </Parameter>
       </Parameters>
       <Docs>
-        <param name="literalName">To be added.</param>
-        <param name="literalValue">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <param name="literalName">The name of the static field.</param>
+        <param name="literalValue">The constant value of the literal.</param>
+        <summary>When overridden in a derived class, defines the named static field in an enumeration type with the specified constant value.</summary>
+        <returns>The defined field.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -3662,9 +3662,9 @@ For information on how to format `binaryAttribute`, see the metadata specificati
         <Parameter Name="binaryAttribute" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="con">To be added.</param>
-        <param name="binaryAttribute">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="con">The constructor for the custom attribute.</param>
+        <param name="binaryAttribute">A <see cref="T:System.ReadOnlySpan`1" /> of bytes representing the attribute.</param>
+        <summary>When overridden in a derived class, sets a custom attribute on this assembly.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -4007,8 +4007,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
         <ReturnType>System.Reflection.Emit.FieldBuilder</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <summary>When overridden in a derived class, gets the underlying field for this enum.</summary>
+        <value>The underlying field for this enum.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

diff --git a/xml/System.Reflection.Emit/EventBuilder.xml b/xml/System.Reflection.Emit/EventBuilder.xml
@@ -113,8 +113,8 @@
       </AssemblyInfo>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <summary>Initializes a new instance of the <see cref="T:System.Reflection.Emit.EventBuilder" /> class.</summary>
+        <remarks>This constructor is invoked by derived classes.</remarks>
       </Docs>
     </Member>
     <Member MemberName="AddOtherMethod">
@@ -191,9 +191,10 @@
         <Parameter Name="mdBuilder" Type="System.Reflection.Emit.MethodBuilder" Index="0" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="mdBuilder">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="mdBuilder">A <see cref="T:System.Reflection.Emit.MethodBuilder" /> object that represents the other method.</param>
+        <summary>When overridden in a derived class, adds one of the "other" methods associated with this event.</summary>
+        <remarks>"Other" methods are methods other than the "on" and "raise" methods associated with an event.
+ This function can be called multiple times to add additional "other" methods.</remarks>
       </Docs>
     </Member>
     <Member MemberName="GetEventToken">
@@ -302,8 +303,8 @@
         <Parameter Name="mdBuilder" Type="System.Reflection.Emit.MethodBuilder" Index="0" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="mdBuilder">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="mdBuilder">A <see cref="T:System.Reflection.Emit.MethodBuilder" /> object that represents the method used to subscribe to this event.</param>
+        <summary>When overridden in a derived class, sets the method used to subscribe to this event.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -471,9 +472,9 @@ For information on how to format `binaryAttribute`, see the metadata specificati
         <Parameter Name="binaryAttribute" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="con">To be added.</param>
-        <param name="binaryAttribute">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="con">The constructor for the custom attribute.</param>
+        <param name="binaryAttribute">A <see cref="T:System.ReadOnlySpan`1" /> of bytes representing the attribute.</param>
+        <summary>When overridden in a derived class, sets a custom attribute on this assembly.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -551,8 +552,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
         <Parameter Name="mdBuilder" Type="System.Reflection.Emit.MethodBuilder" Index="0" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="mdBuilder">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="mdBuilder">A <see cref="T:System.Reflection.Emit.MethodBuilder" /> object that represents the method used to raise this event.</param>
+        <summary>When overridden in a derived class, sets the method used to raise this event.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -630,8 +631,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
         <Parameter Name="mdBuilder" Type="System.Reflection.Emit.MethodBuilder" Index="0" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="mdBuilder">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="mdBuilder">A <see cref="T:System.Reflection.Emit.MethodBuilder" /> object that represents the method used to unsubscribe to this event.</param>
+        <summary>When overridden in a derived class, sets the method used to unsubscribe to this event.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

diff --git a/xml/System.Reflection.Emit/FieldBuilder.xml b/xml/System.Reflection.Emit/FieldBuilder.xml
@@ -116,8 +116,8 @@
       </AssemblyInfo>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <summary>Initializes a new instance of the <see cref="T:System.Reflection.Emit.FieldBuilder" /> class.</summary>
+        <remarks>This constructor is invoked by derived classes.</remarks>
       </Docs>
     </Member>
     <Member MemberName="Attributes">
@@ -820,8 +820,8 @@
         <Parameter Name="defaultValue" Type="System.Object" Index="0" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="defaultValue">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="defaultValue">The new default value for this field.</param>
+        <summary>When overridden in a derived class, sets the default value of this field.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -1007,9 +1007,9 @@ For information on how to format `binaryAttribute`, see the metadata specificati
         <Parameter Name="binaryAttribute" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="con">To be added.</param>
-        <param name="binaryAttribute">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="con">The constructor for the custom attribute.</param>
+        <param name="binaryAttribute">A <see cref="T:System.ReadOnlySpan`1" /> of bytes representing the attribute.</param>
+        <summary>When overridden in a derived class, sets a custom attribute on this assembly.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -1158,8 +1158,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
         <Parameter Name="iOffset" Type="System.Int32" Index="0" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="iOffset">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="iOffset">The offset of the field within the type containing this field.</param>
+        <summary>When overridden in a derived class, specifies the field layout.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

diff --git a/xml/System.Reflection.Emit/GenericTypeParameterBuilder.xml b/xml/System.Reflection.Emit/GenericTypeParameterBuilder.xml
@@ -112,8 +112,8 @@
       </AssemblyInfo>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <summary>Initializes a new instance of <see cref="T:System.Reflection.Emit.GenericTypeParameterBuilder" /> class.</summary>
+        <remarks>This constructor is invoked by derived classes.</remarks>
       </Docs>
     </Member>
     <Member MemberName="Assembly">
@@ -3781,8 +3781,8 @@
         </Parameter>
       </Parameters>
       <Docs>
-        <param name="baseTypeConstraint">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="baseTypeConstraint">The <see cref="T:System.Type" /> that must be inherited by any type that is to be substituted for the type parameter.</param>
+        <summary>When overridden in a derived class, sets the base type that a type must inherit in order to be substituted for the type parameter.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -3932,9 +3932,9 @@ For information on how to format `binaryAttribute`, see the metadata specificati
         <Parameter Name="binaryAttribute" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="con">To be added.</param>
-        <param name="binaryAttribute">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="con">The constructor for the custom attribute.</param>
+        <param name="binaryAttribute">A <see cref="T:System.ReadOnlySpan`1" /> of bytes representing the attribute.</param>
+        <summary>When overridden in a derived class, sets a custom attribute on this assembly.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -4022,8 +4022,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
         <Parameter Name="genericParameterAttributes" Type="System.Reflection.GenericParameterAttributes" Index="0" FrameworkAlternate="net-8.0" />
       </Parameters>
       <Docs>
-        <param name="genericParameterAttributes">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="genericParameterAttributes">A bitwise combination of the enumeration values that represents the variance characteristics and special constraints of the generic type parameter.</param>
+        <summary>When overridden in a derived class, sets the variance characteristics and special constraints of the generic parameter, such as the parameterless constructor constraint.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -4143,8 +4143,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
         </Parameter>
       </Parameters>
       <Docs>
-        <param name="interfaceConstraints">To be added.</param>
-        <summary>To be added.</summary>
+        <param name="interfaceConstraints">An array of <see cref="T:System.Type" /> objects that represent the interfaces a type must implement in order to be substituted for the type parameter.</param>
+        <summary>When overridden in a derived class, sets the interfaces a type must implement in order to be substituted for the type parameter.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>