Skip to content

Commit 06f9a7a

Browse files
tompratt-AQRon Petrusha
tompratt-AQ
authored and
Ron Petrusha
committed
Document Signature APIs in the System.​Reflection.​Metadata Namespace. (dotnet#2630)
* Document Signature APIs in the System.​Reflection.​Metadata Namespace. * Fix tagging error. * Made changes per review comments. * Added Namspace topic and made changes per review comments.
1 parent 5b3692a commit 06f9a7a

19 files changed

+320
-291
lines changed

‎xml/System.Reflection.Metadata/ArrayShape.xml

+23-16
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
</Base>
1313
<Interfaces />
1414
<Docs>
15-
<summary>To be added.</summary>
16-
<remarks>To be added.</remarks>
15+
<summary>Represents the shape of an array type.</summary>
16+
<remarks></remarks>
1717
</Docs>
1818
<Members>
1919
<Member MemberName=".ctor">
@@ -32,11 +32,11 @@
3232
<Parameter Name="lowerBounds" Type="System.Collections.Immutable.ImmutableArray&lt;System.Int32&gt;" />
3333
</Parameters>
3434
<Docs>
35-
<param name="rank">To be added.</param>
36-
<param name="sizes">To be added.</param>
37-
<param name="lowerBounds">To be added.</param>
38-
<summary>To be added.</summary>
39-
<remarks>To be added.</remarks>
35+
<param name="rank">The number of dimensions in the array.</param>
36+
<param name="sizes">The size of each dimension.</param>
37+
<param name="lowerBounds">The lower-bound of each dimension.</param>
38+
<summary>Initializes a new instance of the <see cref="T:System.Reflection.Metadata.ArrayShape"/> structure.</summary>
39+
<remarks></remarks>
4040
</Docs>
4141
</Member>
4242
<Member MemberName="LowerBounds">
@@ -53,9 +53,9 @@
5353
<ReturnType>System.Collections.Immutable.ImmutableArray&lt;System.Int32&gt;</ReturnType>
5454
</ReturnValue>
5555
<Docs>
56-
<summary>To be added.</summary>
57-
<value>To be added.</value>
58-
<remarks>To be added.</remarks>
56+
<summary>Gets the lower-bounds of all dimensions. Length may be smaller than rank, in which case the trailing dimensions have unspecified lower bounds.</summary>
57+
<value>An array of lower-bounds.</value>
58+
<remarks></remarks>
5959
</Docs>
6060
</Member>
6161
<Member MemberName="Rank">
@@ -72,9 +72,9 @@
7272
<ReturnType>System.Int32</ReturnType>
7373
</ReturnValue>
7474
<Docs>
75-
<summary>To be added.</summary>
76-
<value>To be added.</value>
77-
<remarks>To be added.</remarks>
75+
<summary>Gets the number of dimensions in the array.</summary>
76+
<value>The number of dimensions.</value>
77+
<remarks></remarks>
7878
</Docs>
7979
</Member>
8080
<Member MemberName="Sizes">
@@ -91,9 +91,16 @@
9191
<ReturnType>System.Collections.Immutable.ImmutableArray&lt;System.Int32&gt;</ReturnType>
9292
</ReturnValue>
9393
<Docs>
94-
<summary>To be added.</summary>
95-
<value>To be added.</value>
96-
<remarks>To be added.</remarks>
94+
<summary>Gets the sizes of all dimensions.</summary>
95+
<value>An array of sizes.</value>
96+
<remarks>
97+
<format type="text/markdown"><![CDATA[
98+
99+
## Remarks
100+
The number of elements in the returned array may be smaller than the number of dimensions of the array type (its rank). In that case, the trailing dimensions have unspecified sizes.
101+
102+
]]></format>
103+
</remarks>
97104
</Docs>
98105
</Member>
99106
</Members>

‎xml/System.Reflection.Metadata/ConstantTypeCode.xml

+17-17
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
<BaseTypeName>System.Enum</BaseTypeName>
1313
</Base>
1414
<Docs>
15-
<summary>To be added.</summary>
16-
<remarks>To be added.</remarks>
15+
<summary>Specifies values that represent types of metadata constants.</summary>
16+
<remarks></remarks>
1717
</Docs>
1818
<Members>
1919
<Member MemberName="Boolean">
@@ -31,7 +31,7 @@
3131
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
3232
</ReturnValue>
3333
<Docs>
34-
<summary>To be added.</summary>
34+
<summary>A Boolean type.</summary>
3535
</Docs>
3636
</Member>
3737
<Member MemberName="Byte">
@@ -49,7 +49,7 @@
4949
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
5050
</ReturnValue>
5151
<Docs>
52-
<summary>To be added.</summary>
52+
<summary>An unsigned 1-byte integer.</summary>
5353
</Docs>
5454
</Member>
5555
<Member MemberName="Char">
@@ -67,7 +67,7 @@
6767
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
6868
</ReturnValue>
6969
<Docs>
70-
<summary>To be added.</summary>
70+
<summary>A character type.</summary>
7171
</Docs>
7272
</Member>
7373
<Member MemberName="Double">
@@ -85,7 +85,7 @@
8585
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
8686
</ReturnValue>
8787
<Docs>
88-
<summary>To be added.</summary>
88+
<summary>An 8-byte floating point type.</summary>
8989
</Docs>
9090
</Member>
9191
<Member MemberName="Int16">
@@ -103,7 +103,7 @@
103103
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
104104
</ReturnValue>
105105
<Docs>
106-
<summary>To be added.</summary>
106+
<summary>A signed 2-byte integer type.</summary>
107107
</Docs>
108108
</Member>
109109
<Member MemberName="Int32">
@@ -121,7 +121,7 @@
121121
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
122122
</ReturnValue>
123123
<Docs>
124-
<summary>To be added.</summary>
124+
<summary>A signed 4-byte integer type.</summary>
125125
</Docs>
126126
</Member>
127127
<Member MemberName="Int64">
@@ -139,7 +139,7 @@
139139
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
140140
</ReturnValue>
141141
<Docs>
142-
<summary>To be added.</summary>
142+
<summary>A signed 8-byte integer type.</summary>
143143
</Docs>
144144
</Member>
145145
<Member MemberName="Invalid">
@@ -157,7 +157,7 @@
157157
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
158158
</ReturnValue>
159159
<Docs>
160-
<summary>To be added.</summary>
160+
<summary>An invalid type.</summary>
161161
</Docs>
162162
</Member>
163163
<Member MemberName="NullReference">
@@ -175,7 +175,7 @@
175175
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
176176
</ReturnValue>
177177
<Docs>
178-
<summary>To be added.</summary>
178+
<summary>A null reference.</summary>
179179
</Docs>
180180
</Member>
181181
<Member MemberName="SByte">
@@ -193,7 +193,7 @@
193193
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
194194
</ReturnValue>
195195
<Docs>
196-
<summary>To be added.</summary>
196+
<summary>A signed 1-byte integer type.</summary>
197197
</Docs>
198198
</Member>
199199
<Member MemberName="Single">
@@ -211,7 +211,7 @@
211211
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
212212
</ReturnValue>
213213
<Docs>
214-
<summary>To be added.</summary>
214+
<summary>A 4-byte floating point type.</summary>
215215
</Docs>
216216
</Member>
217217
<Member MemberName="String">
@@ -229,7 +229,7 @@
229229
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
230230
</ReturnValue>
231231
<Docs>
232-
<summary>To be added.</summary>
232+
<summary>A <see cref="System.String"/> type.</summary>
233233
</Docs>
234234
</Member>
235235
<Member MemberName="UInt16">
@@ -247,7 +247,7 @@
247247
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
248248
</ReturnValue>
249249
<Docs>
250-
<summary>To be added.</summary>
250+
<summary>An unsigned 2-byte integer type.</summary>
251251
</Docs>
252252
</Member>
253253
<Member MemberName="UInt32">
@@ -265,7 +265,7 @@
265265
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
266266
</ReturnValue>
267267
<Docs>
268-
<summary>To be added.</summary>
268+
<summary>An unsigned 4-byte integer type.</summary>
269269
</Docs>
270270
</Member>
271271
<Member MemberName="UInt64">
@@ -283,7 +283,7 @@
283283
<ReturnType>System.Reflection.Metadata.ConstantTypeCode</ReturnType>
284284
</ReturnValue>
285285
<Docs>
286-
<summary>To be added.</summary>
286+
<summary>An unsigned 8-byte integer type.</summary>
287287
</Docs>
288288
</Member>
289289
</Members>

‎xml/System.Reflection.Metadata/CustomAttributeNamedArgumentKind.xml

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
<BaseTypeName>System.Enum</BaseTypeName>
1313
</Base>
1414
<Docs>
15-
<summary>To be added.</summary>
16-
<remarks>To be added.</remarks>
15+
<summary>Specifies constants that define the kinds of arguments in a custom attribute signature.</summary>
16+
<remarks></remarks>
1717
</Docs>
1818
<Members>
1919
<Member MemberName="Field">
@@ -31,7 +31,7 @@
3131
<ReturnType>System.Reflection.Metadata.CustomAttributeNamedArgumentKind</ReturnType>
3232
</ReturnValue>
3333
<Docs>
34-
<summary>To be added.</summary>
34+
<summary>A field argument.</summary>
3535
</Docs>
3636
</Member>
3737
<Member MemberName="Property">
@@ -49,7 +49,7 @@
4949
<ReturnType>System.Reflection.Metadata.CustomAttributeNamedArgumentKind</ReturnType>
5050
</ReturnValue>
5151
<Docs>
52-
<summary>To be added.</summary>
52+
<summary>A property argument.</summary>
5353
</Docs>
5454
</Member>
5555
</Members>

‎xml/System.Reflection.Metadata/CustomAttributeNamedArgument`1.xml

+21-21
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
</Base>
1616
<Interfaces />
1717
<Docs>
18-
<typeparam name="TType">To be added.</typeparam>
19-
<summary>To be added.</summary>
20-
<remarks>To be added.</remarks>
18+
<typeparam name="TType">The type used to represent types of values decoded from the custom attribute signature.</typeparam>
19+
<summary>Represents a named argument decoded from a custom attribute signature.</summary>
20+
<remarks></remarks>
2121
</Docs>
2222
<Members>
2323
<Member MemberName=".ctor">
@@ -37,12 +37,12 @@
3737
<Parameter Name="value" Type="System.Object" />
3838
</Parameters>
3939
<Docs>
40-
<param name="name">To be added.</param>
41-
<param name="kind">To be added.</param>
42-
<param name="type">To be added.</param>
43-
<param name="value">To be added.</param>
44-
<summary>To be added.</summary>
45-
<remarks>To be added.</remarks>
40+
<param name="name">The name of the argument.</param>
41+
<param name="kind">The kind of the argument.</param>
42+
<param name="type">The type of the argument.</param>
43+
<param name="value">The value of the argument.</param>
44+
<summary>Initializes a new instance of the <see cref="T:System.Reflection.Metadata.CustomAttributeNamedArgument`1" /> structure using the specified name, kind, type, and value.</summary>
45+
<remarks></remarks>
4646
</Docs>
4747
</Member>
4848
<Member MemberName="Kind">
@@ -59,9 +59,9 @@
5959
<ReturnType>System.Reflection.Metadata.CustomAttributeNamedArgumentKind</ReturnType>
6060
</ReturnValue>
6161
<Docs>
62-
<summary>To be added.</summary>
63-
<value>To be added.</value>
64-
<remarks>To be added.</remarks>
62+
<summary>Gets the kind of argument.</summary>
63+
<value>The argument kind.</value>
64+
<remarks></remarks>
6565
</Docs>
6666
</Member>
6767
<Member MemberName="Name">
@@ -78,9 +78,9 @@
7878
<ReturnType>System.String</ReturnType>
7979
</ReturnValue>
8080
<Docs>
81-
<summary>To be added.</summary>
82-
<value>To be added.</value>
83-
<remarks>To be added.</remarks>
81+
<summary>Gets the name of the argument.</summary>
82+
<value>The argument name.</value>
83+
<remarks></remarks>
8484
</Docs>
8585
</Member>
8686
<Member MemberName="Type">
@@ -97,9 +97,9 @@
9797
<ReturnType>TType</ReturnType>
9898
</ReturnValue>
9999
<Docs>
100-
<summary>To be added.</summary>
101-
<value>To be added.</value>
102-
<remarks>To be added.</remarks>
100+
<summary>Gets the type of the argument.</summary>
101+
<value>The argument type.</value>
102+
<remarks></remarks>
103103
</Docs>
104104
</Member>
105105
<Member MemberName="Value">
@@ -116,9 +116,9 @@
116116
<ReturnType>System.Object</ReturnType>
117117
</ReturnValue>
118118
<Docs>
119-
<summary>To be added.</summary>
120-
<value>To be added.</value>
121-
<remarks>To be added.</remarks>
119+
<summary>Gets the value of the argument.</summary>
120+
<value>An object containing the argument value.</value>
121+
<remarks></remarks>
122122
</Docs>
123123
</Member>
124124
</Members>

‎xml/System.Reflection.Metadata/CustomAttributeTypedArgument`1.xml

+13-13
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
</Base>
1616
<Interfaces />
1717
<Docs>
18-
<typeparam name="TType">To be added.</typeparam>
19-
<summary>To be added.</summary>
20-
<remarks>To be added.</remarks>
18+
<typeparam name="TType">The type of the argument.</typeparam>
19+
<summary>Represents a typed argument for a custom metadata attribute.</summary>
20+
<remarks></remarks>
2121
</Docs>
2222
<Members>
2323
<Member MemberName=".ctor">
@@ -35,10 +35,10 @@
3535
<Parameter Name="value" Type="System.Object" />
3636
</Parameters>
3737
<Docs>
38-
<param name="type">To be added.</param>
39-
<param name="value">To be added.</param>
40-
<summary>To be added.</summary>
41-
<remarks>To be added.</remarks>
38+
<param name="type">The type of the argument.</param>
39+
<param name="value">The argument value.</param>
40+
<summary>Initializes a new instance of the <see cref="T:System.Reflection.Metadata.CustomAttributeTypedArgument`1" /> structure using the specified argument type and value.</summary>
41+
<remarks></remarks>
4242
</Docs>
4343
</Member>
4444
<Member MemberName="Type">
@@ -55,9 +55,9 @@
5555
<ReturnType>TType</ReturnType>
5656
</ReturnValue>
5757
<Docs>
58-
<summary>To be added.</summary>
59-
<value>To be added.</value>
60-
<remarks>To be added.</remarks>
58+
<summary>Gets the type of the argument.</summary>
59+
<value>The argument type.</value>
60+
<remarks></remarks>
6161
</Docs>
6262
</Member>
6363
<Member MemberName="Value">
@@ -74,9 +74,9 @@
7474
<ReturnType>System.Object</ReturnType>
7575
</ReturnValue>
7676
<Docs>
77-
<summary>To be added.</summary>
78-
<value>To be added.</value>
79-
<remarks>To be added.</remarks>
77+
<summary>Gets the value of the argument.</summary>
78+
<value>The argument value.</value>
79+
<remarks></remarks>
8080
</Docs>
8181
</Member>
8282
</Members>

0 commit comments

Comments
 (0)