Skip to content

Commit 2528cc3

Browse files
Automatic port of System.Diagnostics.CodeAnalysis documentation (#4671)
* Automatic port of System.Diagnostics.CodeAnalysis documentation * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
1 parent 3d0ef56 commit 2528cc3

7 files changed

+220
-87
lines changed

xml/System.Diagnostics.CodeAnalysis/DynamicDependencyAttribute.xml

Lines changed: 77 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,16 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
24-
<remarks>To be added.</remarks>
23+
<summary>States a dependency that one member has on another.</summary>
24+
<remarks>
25+
<format type="text/markdown"><![CDATA[
26+
27+
## Remarks
28+
29+
This attribute can be used to inform tooling of a dependency that is otherwise not evident purely from metadata and IL, for example, a member relied on via reflection.
30+
31+
]]></format>
32+
</remarks>
2533
</Docs>
2634
<Members>
2735
<Member MemberName=".ctor">
@@ -40,8 +48,8 @@
4048
<Parameter Name="memberSignature" Type="System.String" />
4149
</Parameters>
4250
<Docs>
43-
<param name="memberSignature">To be added.</param>
44-
<summary>To be added.</summary>
51+
<param name="memberSignature">The signature of the member depended on.</param>
52+
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute" /> class with the specified signature of a member on the same type as the consumer.</summary>
4553
<remarks>To be added.</remarks>
4654
</Docs>
4755
</Member>
@@ -62,9 +70,9 @@
6270
<Parameter Name="type" Type="System.Type" />
6371
</Parameters>
6472
<Docs>
65-
<param name="memberTypes">To be added.</param>
66-
<param name="type">To be added.</param>
67-
<summary>To be added.</summary>
73+
<param name="memberTypes">The types of members depended on.</param>
74+
<param name="type">The type that contains the specified members.</param>
75+
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute" /> class with the specified types of members on a <see cref="T:System.Type" />.</summary>
6876
<remarks>To be added.</remarks>
6977
</Docs>
7078
</Member>
@@ -85,9 +93,9 @@
8593
<Parameter Name="type" Type="System.Type" />
8694
</Parameters>
8795
<Docs>
88-
<param name="memberSignature">To be added.</param>
89-
<param name="type">To be added.</param>
90-
<summary>To be added.</summary>
96+
<param name="memberSignature">The signature of the member depended on.</param>
97+
<param name="type">The type that contains <paramref name="memberSignature" />.</param>
98+
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute" /> class with the specified signature of a member on a <see cref="T:System.Type" />.</summary>
9199
<remarks>To be added.</remarks>
92100
</Docs>
93101
</Member>
@@ -109,10 +117,10 @@
109117
<Parameter Name="assemblyName" Type="System.String" />
110118
</Parameters>
111119
<Docs>
112-
<param name="memberTypes">To be added.</param>
113-
<param name="typeName">To be added.</param>
114-
<param name="assemblyName">To be added.</param>
115-
<summary>To be added.</summary>
120+
<param name="memberTypes">The types of members depended on.</param>
121+
<param name="typeName">The full name of the type containing the specified members.</param>
122+
<param name="assemblyName">The assembly name of the type containing the specified members.</param>
123+
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute" /> class with the specified types of members on a type in an assembly.</summary>
116124
<remarks>To be added.</remarks>
117125
</Docs>
118126
</Member>
@@ -134,10 +142,10 @@
134142
<Parameter Name="assemblyName" Type="System.String" />
135143
</Parameters>
136144
<Docs>
137-
<param name="memberSignature">To be added.</param>
138-
<param name="typeName">To be added.</param>
139-
<param name="assemblyName">To be added.</param>
140-
<summary>To be added.</summary>
145+
<param name="memberSignature">The signature of the member depended on.</param>
146+
<param name="typeName">The full name of the type containing the specified member.</param>
147+
<param name="assemblyName">The assembly name of the type containing the specified member.</param>
148+
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute" /> class with the specified signature of a member on a type in an assembly.</summary>
141149
<remarks>To be added.</remarks>
142150
</Docs>
143151
</Member>
@@ -157,9 +165,17 @@
157165
<ReturnType>System.String</ReturnType>
158166
</ReturnValue>
159167
<Docs>
160-
<summary>To be added.</summary>
168+
<summary>Gets the assembly name of the specified type.</summary>
161169
<value>To be added.</value>
162-
<remarks>To be added.</remarks>
170+
<remarks>
171+
<format type="text/markdown"><![CDATA[
172+
173+
## Remarks
174+
175+
<xref:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName> is only valid when <xref:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName> is specified.
176+
177+
]]></format>
178+
</remarks>
163179
</Docs>
164180
</Member>
165181
<Member MemberName="Condition">
@@ -178,7 +194,7 @@
178194
<ReturnType>System.String</ReturnType>
179195
</ReturnValue>
180196
<Docs>
181-
<summary>To be added.</summary>
197+
<summary>Gets or sets the condition in which the dependency is applicable, for example, "DEBUG".</summary>
182198
<value>To be added.</value>
183199
<remarks>To be added.</remarks>
184200
</Docs>
@@ -199,9 +215,17 @@
199215
<ReturnType>System.String</ReturnType>
200216
</ReturnValue>
201217
<Docs>
202-
<summary>To be added.</summary>
218+
<summary>Gets the signature of the member depended on.</summary>
203219
<value>To be added.</value>
204-
<remarks>To be added.</remarks>
220+
<remarks>
221+
<format type="text/markdown"><![CDATA[
222+
223+
## Remarks
224+
225+
Either <xref:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature> must be a valid string or <xref:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes> must not equal <xref:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None>, but not both.
226+
227+
]]></format>
228+
</remarks>
205229
</Docs>
206230
</Member>
207231
<Member MemberName="MemberTypes">
@@ -220,9 +244,17 @@
220244
<ReturnType>System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes</ReturnType>
221245
</ReturnValue>
222246
<Docs>
223-
<summary>To be added.</summary>
247+
<summary>Gets the types of the members that are depended on, for example, fields and properties.</summary>
224248
<value>To be added.</value>
225-
<remarks>To be added.</remarks>
249+
<remarks>
250+
<format type="text/markdown"><![CDATA[
251+
252+
## Remarks
253+
254+
Either <xref:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature> must be a valid string or <xref:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes> must not equal <xref:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None>, but not both.
255+
256+
]]></format>
257+
</remarks>
226258
</Docs>
227259
</Member>
228260
<Member MemberName="Type">
@@ -241,9 +273,17 @@
241273
<ReturnType>System.Type</ReturnType>
242274
</ReturnValue>
243275
<Docs>
244-
<summary>To be added.</summary>
276+
<summary>Gets the <see cref="T:System.Type" /> containing the specified member.</summary>
245277
<value>To be added.</value>
246-
<remarks>To be added.</remarks>
278+
<remarks>
279+
<format type="text/markdown"><![CDATA[
280+
281+
## Remarks
282+
283+
If <xref:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type> and <xref:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName> aren't specified, the type of the consumer is assumed.
284+
285+
]]></format>
286+
</remarks>
247287
</Docs>
248288
</Member>
249289
<Member MemberName="TypeName">
@@ -262,9 +302,17 @@
262302
<ReturnType>System.String</ReturnType>
263303
</ReturnValue>
264304
<Docs>
265-
<summary>To be added.</summary>
305+
<summary>Gets the full name of the type containing the specified member.</summary>
266306
<value>To be added.</value>
267-
<remarks>To be added.</remarks>
307+
<remarks>
308+
<format type="text/markdown"><![CDATA[
309+
310+
## Remarks
311+
312+
If <xref:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type> and <xref:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName> aren't specified, the type of the consumer is assumed.
313+
314+
]]></format>
315+
</remarks>
268316
</Docs>
269317
</Member>
270318
</Members>

xml/System.Diagnostics.CodeAnalysis/DynamicallyAccessedMemberTypes.xml

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
</Attribute>
2020
</Attributes>
2121
<Docs>
22-
<summary>To be added.</summary>
22+
<summary>Specifies the types of members that are dynamically accessed.
23+
This enumeration has a <see cref="T:System.FlagsAttribute" /> attribute that allows a bitwise combination of its member values.</summary>
2324
<remarks>To be added.</remarks>
2425
</Docs>
2526
<Members>
@@ -40,7 +41,8 @@
4041
</ReturnValue>
4142
<MemberValue>-1</MemberValue>
4243
<Docs>
43-
<summary>To be added.</summary>
44+
<summary>Specifies all members.</summary>
45+
<remarks>To be added.</remarks>
4446
</Docs>
4547
</Member>
4648
<Member MemberName="None">
@@ -60,7 +62,8 @@
6062
</ReturnValue>
6163
<MemberValue>0</MemberValue>
6264
<Docs>
63-
<summary>To be added.</summary>
65+
<summary>Specifies no members.</summary>
66+
<remarks>To be added.</remarks>
6467
</Docs>
6568
</Member>
6669
<Member MemberName="NonPublicConstructors">
@@ -80,7 +83,8 @@
8083
</ReturnValue>
8184
<MemberValue>4</MemberValue>
8285
<Docs>
83-
<summary>To be added.</summary>
86+
<summary>Specifies all non-public constructors.</summary>
87+
<remarks>To be added.</remarks>
8488
</Docs>
8589
</Member>
8690
<Member MemberName="NonPublicEvents">
@@ -100,7 +104,8 @@
100104
</ReturnValue>
101105
<MemberValue>4096</MemberValue>
102106
<Docs>
103-
<summary>To be added.</summary>
107+
<summary>Specifies all non-public events.</summary>
108+
<remarks>To be added.</remarks>
104109
</Docs>
105110
</Member>
106111
<Member MemberName="NonPublicFields">
@@ -120,7 +125,8 @@
120125
</ReturnValue>
121126
<MemberValue>64</MemberValue>
122127
<Docs>
123-
<summary>To be added.</summary>
128+
<summary>Specifies all non-public fields.</summary>
129+
<remarks>To be added.</remarks>
124130
</Docs>
125131
</Member>
126132
<Member MemberName="NonPublicMethods">
@@ -140,7 +146,8 @@
140146
</ReturnValue>
141147
<MemberValue>16</MemberValue>
142148
<Docs>
143-
<summary>To be added.</summary>
149+
<summary>Specifies all non-public methods.</summary>
150+
<remarks>To be added.</remarks>
144151
</Docs>
145152
</Member>
146153
<Member MemberName="NonPublicNestedTypes">
@@ -160,7 +167,8 @@
160167
</ReturnValue>
161168
<MemberValue>256</MemberValue>
162169
<Docs>
163-
<summary>To be added.</summary>
170+
<summary>Specifies all non-public nested types.</summary>
171+
<remarks>To be added.</remarks>
164172
</Docs>
165173
</Member>
166174
<Member MemberName="NonPublicProperties">
@@ -180,7 +188,8 @@
180188
</ReturnValue>
181189
<MemberValue>1024</MemberValue>
182190
<Docs>
183-
<summary>To be added.</summary>
191+
<summary>Specifies all non-public properties.</summary>
192+
<remarks>To be added.</remarks>
184193
</Docs>
185194
</Member>
186195
<Member MemberName="PublicConstructors">
@@ -200,7 +209,8 @@
200209
</ReturnValue>
201210
<MemberValue>3</MemberValue>
202211
<Docs>
203-
<summary>To be added.</summary>
212+
<summary>Specifies all public constructors.</summary>
213+
<remarks>To be added.</remarks>
204214
</Docs>
205215
</Member>
206216
<Member MemberName="PublicEvents">
@@ -220,7 +230,8 @@
220230
</ReturnValue>
221231
<MemberValue>2048</MemberValue>
222232
<Docs>
223-
<summary>To be added.</summary>
233+
<summary>Specifies all public events.</summary>
234+
<remarks>To be added.</remarks>
224235
</Docs>
225236
</Member>
226237
<Member MemberName="PublicFields">
@@ -240,7 +251,8 @@
240251
</ReturnValue>
241252
<MemberValue>32</MemberValue>
242253
<Docs>
243-
<summary>To be added.</summary>
254+
<summary>Specifies all public fields.</summary>
255+
<remarks>To be added.</remarks>
244256
</Docs>
245257
</Member>
246258
<Member MemberName="PublicMethods">
@@ -260,7 +272,8 @@
260272
</ReturnValue>
261273
<MemberValue>8</MemberValue>
262274
<Docs>
263-
<summary>To be added.</summary>
275+
<summary>Specifies all public methods.</summary>
276+
<remarks>To be added.</remarks>
264277
</Docs>
265278
</Member>
266279
<Member MemberName="PublicNestedTypes">
@@ -280,7 +293,8 @@
280293
</ReturnValue>
281294
<MemberValue>128</MemberValue>
282295
<Docs>
283-
<summary>To be added.</summary>
296+
<summary>Specifies all public nested types.</summary>
297+
<remarks>To be added.</remarks>
284298
</Docs>
285299
</Member>
286300
<Member MemberName="PublicParameterlessConstructor">
@@ -300,7 +314,8 @@
300314
</ReturnValue>
301315
<MemberValue>1</MemberValue>
302316
<Docs>
303-
<summary>To be added.</summary>
317+
<summary>Specifies the default, parameterless public constructor.</summary>
318+
<remarks>To be added.</remarks>
304319
</Docs>
305320
</Member>
306321
<Member MemberName="PublicProperties">
@@ -320,7 +335,8 @@
320335
</ReturnValue>
321336
<MemberValue>512</MemberValue>
322337
<Docs>
323-
<summary>To be added.</summary>
338+
<summary>Specifies all public properties.</summary>
339+
<remarks>To be added.</remarks>
324340
</Docs>
325341
</Member>
326342
</Members>

xml/System.Diagnostics.CodeAnalysis/DynamicallyAccessedMembersAttribute.xml

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,19 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
24-
<remarks>To be added.</remarks>
23+
<summary>Indicates that certain members on a specified <see cref="T:System.Type" /> are accessed dynamically, for example, through <see cref="N:System.Reflection" />.</summary>
24+
<remarks>
25+
<format type="text/markdown"><![CDATA[
26+
27+
## Remarks
28+
29+
This attribute allows tools to understand which members are being accessed during the execution of a program.
30+
This attribute is valid on members whose type is <xref:System.Type> or <xref:System.String>.
31+
When this attribute is applied to a location of type <xref:System.String>, the assumption is that the string represents a fully qualified type name.
32+
If the attribute is applied to a method, it's treated as a special case and it implies that the attribute should be applied to the "this" parameter of the method. The attribute should only be used on instance methods of types that are assignable to <xref:System.Type> (or `string`, but no methods will use it there).
33+
34+
]]></format>
35+
</remarks>
2536
</Docs>
2637
<Members>
2738
<Member MemberName=".ctor">
@@ -40,8 +51,8 @@
4051
<Parameter Name="memberTypes" Type="System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes" />
4152
</Parameters>
4253
<Docs>
43-
<param name="memberTypes">To be added.</param>
44-
<summary>To be added.</summary>
54+
<param name="memberTypes">The types of the dynamically accessed members.</param>
55+
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute" /> class with the specified member types.</summary>
4556
<remarks>To be added.</remarks>
4657
</Docs>
4758
</Member>
@@ -61,7 +72,7 @@
6172
<ReturnType>System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes</ReturnType>
6273
</ReturnValue>
6374
<Docs>
64-
<summary>To be added.</summary>
75+
<summary>Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes" /> that specifies the type of dynamically accessed members.</summary>
6576
<value>To be added.</value>
6677
<remarks>To be added.</remarks>
6778
</Docs>

0 commit comments

Comments
 (0)