Skip to content

Commit f2f873a

Browse files
jeffhandleyjeffhandley
committed
Formatting tweaks
1 parent e21a9b8 commit f2f873a

File tree

2 files changed

+67
-94
lines changed

2 files changed

+67
-94
lines changed

‎xml/System.Reflection.Metadata/TypeName.xml

Lines changed: 55 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,8 @@
2525
</Attribute>
2626
</Attributes>
2727
<Docs>
28-
<summary>
29-
To be added.
30-
</summary>
31-
<remarks>
32-
To be added.
33-
</remarks>
28+
<summary>To be added.</summary>
29+
<remarks>To be added.</remarks>
3430
</Docs>
3531
<Members>
3632
<Member MemberName="AssemblyName">
@@ -58,9 +54,7 @@ To be added.
5854
<Docs>
5955
<summary>Returns assembly name that contains this type, or <see langword="null" /> if this <see cref="T:System.Reflection.Metadata.TypeName" /> was not created from a fully qualified name.</summary>
6056
<value>To be added.</value>
61-
<remarks>
62-
To be added.
63-
</remarks>
57+
<remarks>To be added.</remarks>
6458
</Docs>
6559
</Member>
6660
<Member MemberName="AssemblyQualifiedName">
@@ -150,9 +144,7 @@ To be added.
150144
<Docs>
151145
<summary>Gets the number of dimensions in an array.</summary>
152146
<returns>An integer that contains the number of dimensions in the current type.</returns>
153-
<remarks>
154-
To be added.
155-
</remarks>
147+
<remarks>To be added.</remarks>
156148
<exception cref="T:System.InvalidOperationException">The current type is not an array.</exception>
157149
</Docs>
158150
</Member>
@@ -253,7 +245,25 @@ To be added.
253245
<Docs>
254246
<summary>Gets the total number of <see cref="T:System.Reflection.Metadata.TypeName" /> instances that are used to describe this instance, including any generic arguments or underlying types.</summary>
255247
<returns>To be added.</returns>
256-
<remarks>This value is computed every time this method gets called, it's not cached. There's not really a parallel concept to this in reflection. Think of it as the total number of <see cref="T:System.Reflection.Metadata.TypeName" /> instances that would be created if you were to totally deconstruct this instance and visit each intermediate <see cref="T:System.Reflection.Metadata.TypeName" /> that occurs as part of deconstruction. "int" and "Person" each have complexities of 1 because they're standalone types. "int[]" has a node count of 2 because to fully inspect it involves inspecting the array type itself, <em>plus</em> unwrapping the underlying type ("int") and inspecting that. "Dictionary&lt;string, List&lt;int[][]&gt;&gt;" has node count 8 because fully visiting it involves inspecting 8 <see cref="T:System.Reflection.Metadata.TypeName" /> instances total: <list type="bullet"> <item>Dictionary&lt;string, List&lt;int[][]&gt;&gt; (the original type)</item> <item>Dictionary`2 (the generic type definition)</item> <item>string (a type argument of Dictionary)</item> <item>List&lt;int[][]&gt; (a type argument of Dictionary)</item> <item>List`1 (the generic type definition)</item> <item>int[][] (a type argument of List)</item> <item>int[] (the underlying type of int[][])</item> <item>int (the underlying type of int[])</item> </list></remarks>
248+
<remarks>
249+
This value is computed every time this method gets called, it's not cached. There's not really a parallel concept to this in reflection.
250+
Think of it as the total number of <see cref="T:System.Reflection.Metadata.TypeName" /> instances that would be created if you were to
251+
totally deconstruct this instance and visit each intermediate <see cref="T:System.Reflection.Metadata.TypeName" /> that occurs as part
252+
of deconstruction. "int" and "Person" each have complexities of 1 because they're standalone types. "int[]" has a node count of 2
253+
because to fully inspect it involves inspecting the array type itself, <em>plus</em> unwrapping the underlying type ("int") and
254+
inspecting that. "Dictionary&lt;string, List&lt;int[][]&gt;&gt;" has node count 8 because fully visiting it involves inspecting 8
255+
<see cref="T:System.Reflection.Metadata.TypeName" /> instances total:
256+
<list type="bullet">
257+
<item>Dictionary&lt;string, List&lt;int[][]&gt;&gt; (the original type)</item>
258+
<item>Dictionary`2 (the generic type definition)</item>
259+
<item>string (a type argument of Dictionary)</item>
260+
<item>List&lt;int[][]&gt; (a type argument of Dictionary)</item>
261+
<item>List`1 (the generic type definition)</item>
262+
<item>int[][] (a type argument of List)</item>
263+
<item>int[] (the underlying type of int[][])</item>
264+
<item>int (the underlying type of int[])</item>
265+
</list>
266+
</remarks>
257267
</Docs>
258268
</Member>
259269
<Member MemberName="IsArray">
@@ -275,9 +285,7 @@ To be added.
275285
<Docs>
276286
<summary>Gets a value that indicates whether this type represents any kind of array, regardless of the array's rank or its bounds.</summary>
277287
<value>To be added.</value>
278-
<remarks>
279-
To be added.
280-
</remarks>
288+
<remarks>To be added.</remarks>
281289
</Docs>
282290
</Member>
283291
<Member MemberName="IsByRef">
@@ -299,9 +307,7 @@ To be added.
299307
<Docs>
300308
<summary>Gets a value that indicates whether this is a managed pointer type (for example, "ref int"). Managed pointer types are sometimes called byref types (<see cref="P:System.Type.IsByRef" />).</summary>
301309
<value>To be added.</value>
302-
<remarks>
303-
To be added.
304-
</remarks>
310+
<remarks>To be added.</remarks>
305311
</Docs>
306312
</Member>
307313
<Member MemberName="IsConstructedGenericType">
@@ -355,9 +361,7 @@ To be added.
355361
<Docs>
356362
<summary>Gets a value that indicates whether this is a nested type (for example, "Namespace.Declaring+Nested"). For nested types <see cref="P:System.Reflection.Metadata.TypeName.DeclaringType" /> returns their declaring type.</summary>
357363
<value>To be added.</value>
358-
<remarks>
359-
To be added.
360-
</remarks>
364+
<remarks>To be added.</remarks>
361365
</Docs>
362366
</Member>
363367
<Member MemberName="IsPointer">
@@ -379,9 +383,7 @@ To be added.
379383
<Docs>
380384
<summary>Gets a value that indicates whether this type represents an unmanaged pointer (for example, "int*" or "void*"). Unmanaged pointer types are often just called pointers (<see cref="P:System.Type.IsPointer" />).</summary>
381385
<value>To be added.</value>
382-
<remarks>
383-
To be added.
384-
</remarks>
386+
<remarks>To be added.</remarks>
385387
</Docs>
386388
</Member>
387389
<Member MemberName="IsSimple">
@@ -413,7 +415,13 @@ To be added.
413415
<Docs>
414416
<summary>Gets a value that indicates whether this is a "plain" type; that is, not an array, not a pointer, not a reference, and not a constructed generic type. Examples of elemental types are "System.Int32", "System.Uri", and "YourNamespace.YourClass".</summary>
415417
<value>To be added.</value>
416-
<remarks>This property returning <see langword="true" /> doesn't mean that the type is a primitive like string or int; it just means that there's no underlying type. This property will return <see langword="true" /> for generic type definitions (for example, "Dictionary&lt;,&gt;"). This is because determining whether a type truly is a generic type requires loading the type and performing a runtime check.</remarks>
418+
<remarks>
419+
<para>This property returning <see langword="true" /> doesn't mean that the type is a primitive like string or int; it just means that there's no underlying type.</para>
420+
<para>
421+
This property will return <see langword="true" /> for generic type definitions (for example, "Dictionary&lt;,&gt;"). This is because determining whether a type
422+
truly is a generic type requires loading the type and performing a runtime check.
423+
</para>
424+
</remarks>
417425
</Docs>
418426
</Member>
419427
<Member MemberName="IsSZArray">
@@ -435,9 +443,7 @@ To be added.
435443
<Docs>
436444
<summary>Gets a value that indicates whether this type represents a single-dimensional, zero-indexed array (for example, "int[]").</summary>
437445
<value>To be added.</value>
438-
<remarks>
439-
To be added.
440-
</remarks>
446+
<remarks>To be added.</remarks>
441447
</Docs>
442448
</Member>
443449
<Member MemberName="IsVariableBoundArrayType">
@@ -459,9 +465,7 @@ To be added.
459465
<Docs>
460466
<summary>Gets a value that indicates whether this type represents a variable-bound array; that is, an array of rank greater than 1 (for example, "int[,]") or a single-dimensional array that isn't necessarily zero-indexed.</summary>
461467
<value>To be added.</value>
462-
<remarks>
463-
To be added.
464-
</remarks>
468+
<remarks>To be added.</remarks>
465469
</Docs>
466470
</Member>
467471
<Member MemberName="MakeArrayTypeName">
@@ -485,13 +489,9 @@ To be added.
485489
</Parameters>
486490
<Docs>
487491
<param name="rank">To be added.</param>
488-
<summary>
489-
To be added.
490-
</summary>
492+
<summary>To be added.</summary>
491493
<returns>To be added.</returns>
492-
<remarks>
493-
To be added.
494-
</remarks>
494+
<remarks>To be added.</remarks>
495495
</Docs>
496496
</Member>
497497
<Member MemberName="MakeByRefTypeName">
@@ -512,13 +512,9 @@ To be added.
512512
</ReturnValue>
513513
<Parameters />
514514
<Docs>
515-
<summary>
516-
To be added.
517-
</summary>
515+
<summary>To be added.</summary>
518516
<returns>To be added.</returns>
519-
<remarks>
520-
To be added.
521-
</remarks>
517+
<remarks>To be added.</remarks>
522518
</Docs>
523519
</Member>
524520
<Member MemberName="MakeGenericTypeName">
@@ -549,13 +545,9 @@ To be added.
549545
</Parameters>
550546
<Docs>
551547
<param name="typeArguments">To be added.</param>
552-
<summary>
553-
To be added.
554-
</summary>
548+
<summary>To be added.</summary>
555549
<returns>To be added.</returns>
556-
<remarks>
557-
To be added.
558-
</remarks>
550+
<remarks>To be added.</remarks>
559551
</Docs>
560552
</Member>
561553
<Member MemberName="MakePointerTypeName">
@@ -576,13 +568,9 @@ To be added.
576568
</ReturnValue>
577569
<Parameters />
578570
<Docs>
579-
<summary>
580-
To be added.
581-
</summary>
571+
<summary>To be added.</summary>
582572
<returns>To be added.</returns>
583-
<remarks>
584-
To be added.
585-
</remarks>
573+
<remarks>To be added.</remarks>
586574
</Docs>
587575
</Member>
588576
<Member MemberName="MakeSZArrayTypeName">
@@ -603,13 +591,9 @@ To be added.
603591
</ReturnValue>
604592
<Parameters />
605593
<Docs>
606-
<summary>
607-
To be added.
608-
</summary>
594+
<summary>To be added.</summary>
609595
<returns>To be added.</returns>
610-
<remarks>
611-
To be added.
612-
</remarks>
596+
<remarks>To be added.</remarks>
613597
</Docs>
614598
</Member>
615599
<Member MemberName="Name">
@@ -631,9 +615,7 @@ To be added.
631615
<Docs>
632616
<summary>Gets the name of this type, without the namespace and the assembly name; for example, "Int32". Nested types are represented without a '+'; for example, "MyNamespace.MyType+NestedType" is just "NestedType".</summary>
633617
<value>To be added.</value>
634-
<remarks>
635-
To be added.
636-
</remarks>
618+
<remarks>To be added.</remarks>
637619
</Docs>
638620
</Member>
639621
<Member MemberName="Namespace">
@@ -652,13 +634,9 @@ To be added.
652634
<ReturnType>System.String</ReturnType>
653635
</ReturnValue>
654636
<Docs>
655-
<summary>
656-
To be added.
657-
</summary>
637+
<summary>To be added.</summary>
658638
<value>To be added.</value>
659-
<remarks>
660-
To be added.
661-
</remarks>
639+
<remarks>To be added.</remarks>
662640
</Docs>
663641
</Member>
664642
<Member MemberName="Parse">
@@ -698,9 +676,7 @@ To be added.
698676
<param name="options">An object that describes optional <see cref="T:System.Reflection.Metadata.TypeNameParseOptions" /> parameters to use.</param>
699677
<summary>Parses a span of characters into a type name.</summary>
700678
<returns>Parsed type name.</returns>
701-
<remarks>
702-
To be added.
703-
</remarks>
679+
<remarks>To be added.</remarks>
704680
<exception cref="T:System.ArgumentException">Provided type name was invalid.</exception>
705681
<exception cref="T:System.InvalidOperationException">Parsing has exceeded the limit set by <see cref="P:System.Reflection.Metadata.TypeNameParseOptions.MaxNodes" />.</exception>
706682
</Docs>
@@ -746,9 +722,7 @@ To be added.
746722
<summary>Tries to parse a span of characters into a type name.</summary>
747723
<returns>
748724
<see langword="true" /> if type name was converted successfully, otherwise, <see langword="false" />.</returns>
749-
<remarks>
750-
To be added.
751-
</remarks>
725+
<remarks>To be added.</remarks>
752726
</Docs>
753727
</Member>
754728
<Member MemberName="Unescape">
@@ -771,13 +745,9 @@ To be added.
771745
</Parameters>
772746
<Docs>
773747
<param name="name">To be added.</param>
774-
<summary>
775-
To be added.
776-
</summary>
748+
<summary>To be added.</summary>
777749
<returns>To be added.</returns>
778-
<remarks>
779-
To be added.
780-
</remarks>
750+
<remarks>To be added.</remarks>
781751
</Docs>
782752
</Member>
783753
<Member MemberName="WithAssemblyName">
@@ -808,13 +778,9 @@ To be added.
808778
</Parameters>
809779
<Docs>
810780
<param name="assemblyName">To be added.</param>
811-
<summary>
812-
To be added.
813-
</summary>
781+
<summary>To be added.</summary>
814782
<returns>To be added.</returns>
815-
<remarks>
816-
To be added.
817-
</remarks>
783+
<remarks>To be added.</remarks>
818784
</Docs>
819785
</Member>
820786
</Members>

‎xml/System.Text.Json.Serialization.Metadata/JsonParameterInfo.xml

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@
5151
<summary>Gets a custom attribute provider for the current parameter.</summary>
5252
<value>To be added.</value>
5353
<remarks>
54-
When resolving metadata via the built-in resolvers this will be populated with
55-
the underlying <see cref="T:System.Reflection.ParameterInfo" /> of the constructor metadata.
54+
When resolving metadata via the built-in resolvers this will be populated with
55+
the underlying <see cref="T:System.Reflection.ParameterInfo" /> of the constructor metadata.
5656
</remarks>
5757
</Docs>
5858
</Member>
@@ -148,8 +148,8 @@
148148
<summary>Gets a value indicating whether the parameter represents a required or init-only member initializer.</summary>
149149
<value>To be added.</value>
150150
<remarks>
151-
Only returns <see langword="true" /> for source-generated metadata that can only access
152-
required or init-only member initializers using object initialize expressions.
151+
Only returns <see langword="true" /> for source-generated metadata that can only access
152+
required or init-only member initializers using object initialize expressions.
153153
</remarks>
154154
</Docs>
155155
</Member>
@@ -173,7 +173,14 @@
173173
<summary>Gets a value indicating whether the constructor parameter is annotated as nullable.</summary>
174174
<value>To be added.</value>
175175
<remarks>
176-
Contracts originating from <see cref="T:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver" /> or <see cref="T:System.Text.Json.Serialization.JsonSerializerContext" />, derive the value of this parameter from nullable reference type annotations, including annotations from attributes such as <see cref="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute" /> or <see cref="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute" />. This property has no effect on deserialization unless the <see cref="P:System.Text.Json.JsonSerializerOptions.RespectNullableAnnotations" /> property has been enabled, in which case the serializer will reject any <see langword="null" /> deserialization results. This setting is in sync with the associated <see cref="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.IsSetNullable" /> property.
176+
Contracts originating from <see cref="T:System.Text.Json.Serialization.Metadata.DefaultJsonTypeInfoResolver" /> or
177+
<see cref="T:System.Text.Json.Serialization.JsonSerializerContext" />, derive the value of this parameter from nullable
178+
reference type annotations, including annotations from attributes such as
179+
<see cref="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute" /> or
180+
<see cref="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute" />. This property has no effect on deserialization
181+
unless the <see cref="P:System.Text.Json.JsonSerializerOptions.RespectNullableAnnotations" /> property has been enabled,
182+
in which case the serializer will reject any <see langword="null" /> deserialization results. This setting is in sync
183+
with the associated <see cref="P:System.Text.Json.Serialization.Metadata.JsonPropertyInfo.IsSetNullable" /> property.
177184
</remarks>
178185
</Docs>
179186
</Member>

0 commit comments

Comments
 (0)