Skip to content

Commit ed9c008

Browse files
buyaa-ngewarren
buyaa-n
and
gewarren
authored
Add Reflection.Emit missing docs (#9221)
* Add Reflection.Emit missing docs * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
1 parent 695b963 commit ed9c008

12 files changed

+310
-307
lines changed

‎xml/System.Reflection.Emit/AssemblyBuilder.xml‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,8 @@ The following code example shows how to define and use a dynamic assembly. The e
157157
</AssemblyInfo>
158158
<Parameters />
159159
<Docs>
160-
<summary>To be added.</summary>
161-
<remarks>To be added.</remarks>
160+
<summary>Initializes a new instance of the <see cref="T:System.Reflection.Emit.AssemblyBuilder" /> class.</summary>
161+
<remarks>This constructor is invoked by derived classes.</remarks>
162162
</Docs>
163163
</Member>
164164
<MemberGroup MemberName="AddResourceFile">
@@ -954,10 +954,10 @@ The following code example shows how to define and use a dynamic assembly. The e
954954
<Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="net-8.0" />
955955
</Parameters>
956956
<Docs>
957-
<param name="name">To be added.</param>
958-
<summary>To be added.</summary>
959-
<returns>To be added.</returns>
960-
<remarks>To be added.</remarks>
957+
<param name="name">The name of the dynamic module.</param>
958+
<summary>When overridden in a derived class, defines a dynamic module in this assembly.</summary>
959+
<returns>A <see cref="T:System.Reflection.Emit.ModuleBuilder" /> representing the defined dynamic module.</returns>
960+
<remarks>.NET Core supports only one module.</remarks>
961961
</Docs>
962962
</Member>
963963
<MemberGroup MemberName="DefineResource">
@@ -1801,10 +1801,10 @@ The following code example shows how to define and use a dynamic assembly. The e
18011801
<Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="net-8.0" />
18021802
</Parameters>
18031803
<Docs>
1804-
<param name="name">To be added.</param>
1805-
<summary>To be added.</summary>
1806-
<returns>To be added.</returns>
1807-
<remarks>To be added.</remarks>
1804+
<param name="name">The name of the requested dynamic module.</param>
1805+
<summary>When overridden in a derived class, returns the dynamic module with the specified name.</summary>
1806+
<returns>A <see cref="T:System.Reflection.Emit.ModuleBuilder" /> representing the requested dynamic module.</returns>
1807+
<remarks>.NET Core supports only one module.</remarks>
18081808
</Docs>
18091809
</Member>
18101810
<Member MemberName="GetExportedTypes">
@@ -3446,9 +3446,9 @@ For information on how to format `binaryAttribute`, see the metadata specificati
34463446
<Parameter Name="binaryAttribute" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="net-8.0" />
34473447
</Parameters>
34483448
<Docs>
3449-
<param name="con">To be added.</param>
3450-
<param name="binaryAttribute">To be added.</param>
3451-
<summary>To be added.</summary>
3449+
<param name="con">The constructor for the custom attribute.</param>
3450+
<param name="binaryAttribute">A <see cref="T:System.ReadOnlySpan`1" /> of bytes representing the attribute.</param>
3451+
<summary>When overridden in a derived class, sets a custom attribute on this assembly.</summary>
34523452
<remarks>To be added.</remarks>
34533453
</Docs>
34543454
</Member>

‎xml/System.Reflection.Emit/ConstructorBuilder.xml‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@
123123
<Parameters />
124124
<Docs>
125125
<summary>Initializes a new instance of the <see cref="T:System.Reflection.Emit.ConstructorBuilder" /> class.</summary>
126-
<remarks>To be added.</remarks>
126+
<remarks>This constructor is invoked by derived classes.</remarks>
127127
</Docs>
128128
</Member>
129129
<Member MemberName="AddDeclarativeSecurity">
@@ -436,11 +436,11 @@
436436
<Parameter Name="strParamName" Type="System.String" Index="2" FrameworkAlternate="net-8.0" />
437437
</Parameters>
438438
<Docs>
439-
<param name="iSequence">To be added.</param>
440-
<param name="attributes">To be added.</param>
441-
<param name="strParamName">To be added.</param>
442-
<summary>To be added.</summary>
443-
<returns>To be added.</returns>
439+
<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>
440+
<param name="attributes">The attributes of the parameter.</param>
441+
<param name="strParamName">The name of the parameter. The name can be the <see langword="null" /> string.</param>
442+
<summary>When overridden in a derived class, defines a parameter of this constructor.</summary>
443+
<returns>A <see cref="T:System.Reflection.Emit.ParameterBuilder" /> that represents the new parameter of this constructor.</returns>
444444
<remarks>To be added.</remarks>
445445
</Docs>
446446
</Member>
@@ -707,9 +707,9 @@
707707
<Parameter Name="streamSize" Type="System.Int32" Index="0" FrameworkAlternate="net-8.0" />
708708
</Parameters>
709709
<Docs>
710-
<param name="streamSize">To be added.</param>
711-
<summary>To be added.</summary>
712-
<returns>To be added.</returns>
710+
<param name="streamSize">The size of the IL stream, in bytes.</param>
711+
<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>
712+
<returns>An <see cref="T:System.Reflection.Emit.ILGenerator" /> for this constructor.</returns>
713713
<remarks>To be added.</remarks>
714714
</Docs>
715715
</Member>
@@ -967,8 +967,8 @@
967967
<ReturnType>System.Boolean</ReturnType>
968968
</ReturnValue>
969969
<Docs>
970-
<summary>To be added.</summary>
971-
<value>To be added.</value>
970+
<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>
971+
<value><see langword="true" /> if the local variables in this constructor are initialized to 0; otherwise, <see langword="false" />.</value>
972972
<remarks>To be added.</remarks>
973973
</Docs>
974974
</Member>
@@ -1654,9 +1654,9 @@ For information on how to format `binaryAttribute`, see the metadata specificati
16541654
<Parameter Name="binaryAttribute" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="net-8.0" />
16551655
</Parameters>
16561656
<Docs>
1657-
<param name="con">To be added.</param>
1658-
<param name="binaryAttribute">To be added.</param>
1659-
<summary>To be added.</summary>
1657+
<param name="con">The constructor for the custom attribute.</param>
1658+
<param name="binaryAttribute">A <see cref="T:System.ReadOnlySpan`1" /> of bytes representing the attribute.</param>
1659+
<summary>When overridden in a derived class, sets a custom attribute on this constructor.</summary>
16601660
<remarks>To be added.</remarks>
16611661
</Docs>
16621662
</Member>
@@ -1736,8 +1736,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
17361736
<Parameter Name="attributes" Type="System.Reflection.MethodImplAttributes" Index="0" FrameworkAlternate="net-8.0" />
17371737
</Parameters>
17381738
<Docs>
1739-
<param name="attributes">To be added.</param>
1740-
<summary>To be added.</summary>
1739+
<param name="attributes">A bitwise combination of the enumeration values that specifies how the method is implemented.</param>
1740+
<summary>When overridden in a derived class, sets the method implementation flags for this constructor.</summary>
17411741
<remarks>To be added.</remarks>
17421742
</Docs>
17431743
</Member>

‎xml/System.Reflection.Emit/EnumBuilder.xml‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@
129129
</AssemblyInfo>
130130
<Parameters />
131131
<Docs>
132-
<summary>To be added.</summary>
133-
<remarks>To be added.</remarks>
132+
<summary>Initializes a new instance of the <see cref="T:System.Reflection.Emit.EnumBuilder" /> class.</summary>
133+
<remarks>This constructor is invoked by derived classes.</remarks>
134134
</Docs>
135135
</Member>
136136
<Member MemberName="Assembly">
@@ -472,8 +472,8 @@
472472
</ReturnValue>
473473
<Parameters />
474474
<Docs>
475-
<summary>To be added.</summary>
476-
<returns>To be added.</returns>
475+
<summary>When overridden in a derived class, gets a <see cref="T:System.Reflection.TypeInfo" /> object that represents this enumeration.</summary>
476+
<returns>A <see cref="T:System.Reflection.TypeInfo" /> object that represents this enumeration.</returns>
477477
<remarks>To be added.</remarks>
478478
</Docs>
479479
</Member>
@@ -659,10 +659,10 @@
659659
</Parameter>
660660
</Parameters>
661661
<Docs>
662-
<param name="literalName">To be added.</param>
663-
<param name="literalValue">To be added.</param>
664-
<summary>To be added.</summary>
665-
<returns>To be added.</returns>
662+
<param name="literalName">The name of the static field.</param>
663+
<param name="literalValue">The constant value of the literal.</param>
664+
<summary>When overridden in a derived class, defines the named static field in an enumeration type with the specified constant value.</summary>
665+
<returns>The defined field.</returns>
666666
<remarks>To be added.</remarks>
667667
</Docs>
668668
</Member>
@@ -3662,9 +3662,9 @@ For information on how to format `binaryAttribute`, see the metadata specificati
36623662
<Parameter Name="binaryAttribute" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="net-8.0" />
36633663
</Parameters>
36643664
<Docs>
3665-
<param name="con">To be added.</param>
3666-
<param name="binaryAttribute">To be added.</param>
3667-
<summary>To be added.</summary>
3665+
<param name="con">The constructor for the custom attribute.</param>
3666+
<param name="binaryAttribute">A <see cref="T:System.ReadOnlySpan`1" /> of bytes representing the attribute.</param>
3667+
<summary>When overridden in a derived class, sets a custom attribute on this assembly.</summary>
36683668
<remarks>To be added.</remarks>
36693669
</Docs>
36703670
</Member>
@@ -4007,8 +4007,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
40074007
<ReturnType>System.Reflection.Emit.FieldBuilder</ReturnType>
40084008
</ReturnValue>
40094009
<Docs>
4010-
<summary>To be added.</summary>
4011-
<value>To be added.</value>
4010+
<summary>When overridden in a derived class, gets the underlying field for this enum.</summary>
4011+
<value>The underlying field for this enum.</value>
40124012
<remarks>To be added.</remarks>
40134013
</Docs>
40144014
</Member>

‎xml/System.Reflection.Emit/EventBuilder.xml‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@
113113
</AssemblyInfo>
114114
<Parameters />
115115
<Docs>
116-
<summary>To be added.</summary>
117-
<remarks>To be added.</remarks>
116+
<summary>Initializes a new instance of the <see cref="T:System.Reflection.Emit.EventBuilder" /> class.</summary>
117+
<remarks>This constructor is invoked by derived classes.</remarks>
118118
</Docs>
119119
</Member>
120120
<Member MemberName="AddOtherMethod">
@@ -191,9 +191,10 @@
191191
<Parameter Name="mdBuilder" Type="System.Reflection.Emit.MethodBuilder" Index="0" FrameworkAlternate="net-8.0" />
192192
</Parameters>
193193
<Docs>
194-
<param name="mdBuilder">To be added.</param>
195-
<summary>To be added.</summary>
196-
<remarks>To be added.</remarks>
194+
<param name="mdBuilder">A <see cref="T:System.Reflection.Emit.MethodBuilder" /> object that represents the other method.</param>
195+
<summary>When overridden in a derived class, adds one of the "other" methods associated with this event.</summary>
196+
<remarks>"Other" methods are methods other than the "on" and "raise" methods associated with an event.
197+
This function can be called multiple times to add additional "other" methods.</remarks>
197198
</Docs>
198199
</Member>
199200
<Member MemberName="GetEventToken">
@@ -302,8 +303,8 @@
302303
<Parameter Name="mdBuilder" Type="System.Reflection.Emit.MethodBuilder" Index="0" FrameworkAlternate="net-8.0" />
303304
</Parameters>
304305
<Docs>
305-
<param name="mdBuilder">To be added.</param>
306-
<summary>To be added.</summary>
306+
<param name="mdBuilder">A <see cref="T:System.Reflection.Emit.MethodBuilder" /> object that represents the method used to subscribe to this event.</param>
307+
<summary>When overridden in a derived class, sets the method used to subscribe to this event.</summary>
307308
<remarks>To be added.</remarks>
308309
</Docs>
309310
</Member>
@@ -471,9 +472,9 @@ For information on how to format `binaryAttribute`, see the metadata specificati
471472
<Parameter Name="binaryAttribute" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="net-8.0" />
472473
</Parameters>
473474
<Docs>
474-
<param name="con">To be added.</param>
475-
<param name="binaryAttribute">To be added.</param>
476-
<summary>To be added.</summary>
475+
<param name="con">The constructor for the custom attribute.</param>
476+
<param name="binaryAttribute">A <see cref="T:System.ReadOnlySpan`1" /> of bytes representing the attribute.</param>
477+
<summary>When overridden in a derived class, sets a custom attribute on this assembly.</summary>
477478
<remarks>To be added.</remarks>
478479
</Docs>
479480
</Member>
@@ -551,8 +552,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
551552
<Parameter Name="mdBuilder" Type="System.Reflection.Emit.MethodBuilder" Index="0" FrameworkAlternate="net-8.0" />
552553
</Parameters>
553554
<Docs>
554-
<param name="mdBuilder">To be added.</param>
555-
<summary>To be added.</summary>
555+
<param name="mdBuilder">A <see cref="T:System.Reflection.Emit.MethodBuilder" /> object that represents the method used to raise this event.</param>
556+
<summary>When overridden in a derived class, sets the method used to raise this event.</summary>
556557
<remarks>To be added.</remarks>
557558
</Docs>
558559
</Member>
@@ -630,8 +631,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
630631
<Parameter Name="mdBuilder" Type="System.Reflection.Emit.MethodBuilder" Index="0" FrameworkAlternate="net-8.0" />
631632
</Parameters>
632633
<Docs>
633-
<param name="mdBuilder">To be added.</param>
634-
<summary>To be added.</summary>
634+
<param name="mdBuilder">A <see cref="T:System.Reflection.Emit.MethodBuilder" /> object that represents the method used to unsubscribe to this event.</param>
635+
<summary>When overridden in a derived class, sets the method used to unsubscribe to this event.</summary>
635636
<remarks>To be added.</remarks>
636637
</Docs>
637638
</Member>

‎xml/System.Reflection.Emit/FieldBuilder.xml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@
116116
</AssemblyInfo>
117117
<Parameters />
118118
<Docs>
119-
<summary>To be added.</summary>
120-
<remarks>To be added.</remarks>
119+
<summary>Initializes a new instance of the <see cref="T:System.Reflection.Emit.FieldBuilder" /> class.</summary>
120+
<remarks>This constructor is invoked by derived classes.</remarks>
121121
</Docs>
122122
</Member>
123123
<Member MemberName="Attributes">
@@ -820,8 +820,8 @@
820820
<Parameter Name="defaultValue" Type="System.Object" Index="0" FrameworkAlternate="net-8.0" />
821821
</Parameters>
822822
<Docs>
823-
<param name="defaultValue">To be added.</param>
824-
<summary>To be added.</summary>
823+
<param name="defaultValue">The new default value for this field.</param>
824+
<summary>When overridden in a derived class, sets the default value of this field.</summary>
825825
<remarks>To be added.</remarks>
826826
</Docs>
827827
</Member>
@@ -1007,9 +1007,9 @@ For information on how to format `binaryAttribute`, see the metadata specificati
10071007
<Parameter Name="binaryAttribute" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="net-8.0" />
10081008
</Parameters>
10091009
<Docs>
1010-
<param name="con">To be added.</param>
1011-
<param name="binaryAttribute">To be added.</param>
1012-
<summary>To be added.</summary>
1010+
<param name="con">The constructor for the custom attribute.</param>
1011+
<param name="binaryAttribute">A <see cref="T:System.ReadOnlySpan`1" /> of bytes representing the attribute.</param>
1012+
<summary>When overridden in a derived class, sets a custom attribute on this assembly.</summary>
10131013
<remarks>To be added.</remarks>
10141014
</Docs>
10151015
</Member>
@@ -1158,8 +1158,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
11581158
<Parameter Name="iOffset" Type="System.Int32" Index="0" FrameworkAlternate="net-8.0" />
11591159
</Parameters>
11601160
<Docs>
1161-
<param name="iOffset">To be added.</param>
1162-
<summary>To be added.</summary>
1161+
<param name="iOffset">The offset of the field within the type containing this field.</param>
1162+
<summary>When overridden in a derived class, specifies the field layout.</summary>
11631163
<remarks>To be added.</remarks>
11641164
</Docs>
11651165
</Member>

‎xml/System.Reflection.Emit/GenericTypeParameterBuilder.xml‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@
112112
</AssemblyInfo>
113113
<Parameters />
114114
<Docs>
115-
<summary>To be added.</summary>
116-
<remarks>To be added.</remarks>
115+
<summary>Initializes a new instance of <see cref="T:System.Reflection.Emit.GenericTypeParameterBuilder" /> class.</summary>
116+
<remarks>This constructor is invoked by derived classes.</remarks>
117117
</Docs>
118118
</Member>
119119
<Member MemberName="Assembly">
@@ -3781,8 +3781,8 @@
37813781
</Parameter>
37823782
</Parameters>
37833783
<Docs>
3784-
<param name="baseTypeConstraint">To be added.</param>
3785-
<summary>To be added.</summary>
3784+
<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>
3785+
<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>
37863786
<remarks>To be added.</remarks>
37873787
</Docs>
37883788
</Member>
@@ -3932,9 +3932,9 @@ For information on how to format `binaryAttribute`, see the metadata specificati
39323932
<Parameter Name="binaryAttribute" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="net-8.0" />
39333933
</Parameters>
39343934
<Docs>
3935-
<param name="con">To be added.</param>
3936-
<param name="binaryAttribute">To be added.</param>
3937-
<summary>To be added.</summary>
3935+
<param name="con">The constructor for the custom attribute.</param>
3936+
<param name="binaryAttribute">A <see cref="T:System.ReadOnlySpan`1" /> of bytes representing the attribute.</param>
3937+
<summary>When overridden in a derived class, sets a custom attribute on this assembly.</summary>
39383938
<remarks>To be added.</remarks>
39393939
</Docs>
39403940
</Member>
@@ -4022,8 +4022,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
40224022
<Parameter Name="genericParameterAttributes" Type="System.Reflection.GenericParameterAttributes" Index="0" FrameworkAlternate="net-8.0" />
40234023
</Parameters>
40244024
<Docs>
4025-
<param name="genericParameterAttributes">To be added.</param>
4026-
<summary>To be added.</summary>
4025+
<param name="genericParameterAttributes">A bitwise combination of the enumeration values that represents the variance characteristics and special constraints of the generic type parameter.</param>
4026+
<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>
40274027
<remarks>To be added.</remarks>
40284028
</Docs>
40294029
</Member>
@@ -4143,8 +4143,8 @@ For information on how to format `binaryAttribute`, see the metadata specificati
41434143
</Parameter>
41444144
</Parameters>
41454145
<Docs>
4146-
<param name="interfaceConstraints">To be added.</param>
4147-
<summary>To be added.</summary>
4146+
<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>
4147+
<summary>When overridden in a derived class, sets the interfaces a type must implement in order to be substituted for the type parameter.</summary>
41484148
<remarks>To be added.</remarks>
41494149
</Docs>
41504150
</Member>

0 commit comments

Comments
 (0)