Skip to content

Commit df5b7af

Browse files
committed
System.Reflection docs
1 parent e2f9835 commit df5b7af

File tree

4 files changed

+20
-7
lines changed

4 files changed

+20
-7
lines changed

xml/System.Reflection.Metadata/AssemblyNameInfo.xml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,9 @@
9595
<Docs>
9696
<summary>Gets the name of the culture associated with the assembly.</summary>
9797
<value>To be added.</value>
98-
<remarks>To be added.</remarks>
98+
<remarks>
99+
<para>Do not create a <see cref="T:System.Globalization.CultureInfo" /> instance from this string unless you know the string has originated from a trustworthy source.</para>
100+
</remarks>
99101
</Docs>
100102
</Member>
101103
<Member MemberName="Flags">
@@ -251,7 +253,9 @@
251253
<Docs>
252254
<summary>Initializes a new instance of the <see cref="T:System.Reflection.AssemblyName" /> class based on the stored information.</summary>
253255
<returns>To be added.</returns>
254-
<remarks>To be added.</remarks>
256+
<remarks>
257+
<para>Do not create an <see cref="T:System.Reflection.AssemblyName" /> instance with <see cref="P:System.Reflection.Metadata.AssemblyNameInfo.CultureName" /> string unless you know the string has originated from a trustworthy source.</para>
258+
</remarks>
255259
</Docs>
256260
</Member>
257261
<Member MemberName="TryParse">

xml/System.Reflection.Metadata/TypeName.xml

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,9 @@
254254
inspecting that. "Dictionary&lt;string, List&lt;int[][]&gt;&gt;" has node count 8 because fully visiting it involves inspecting 8
255255
<see cref="T:System.Reflection.Metadata.TypeName" /> instances total:
256256
<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>
257+
<exception cref="T:System.OverflowException">
258+
<para>The total number of <see cref="T:System.Reflection.Metadata.TypeName" /> instances that are used to describe this instance exceed <see cref="F:System.Int32.MaxValue" />.</para>
259+
</exception>
257260
</Docs>
258261
</Member>
259262
<Member MemberName="IsArray">
@@ -624,9 +627,10 @@
624627
<ReturnType>System.String</ReturnType>
625628
</ReturnValue>
626629
<Docs>
627-
<summary>To be added.</summary>
630+
<summary>The namespace of this type; e.g., "System".</summary>
628631
<value>To be added.</value>
629632
<remarks>To be added.</remarks>
633+
<exception cref="T:System.InvalidOperationException">This instance is a nested type.</exception>
630634
</Docs>
631635
</Member>
632636
<Member MemberName="Parse">
@@ -734,10 +738,13 @@
734738
<Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="net-10.0;net-10.0-pp;net-8.0-pp;net-9.0-pp;netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp;netstandard-2.0-pp" />
735739
</Parameters>
736740
<Docs>
737-
<param name="name">To be added.</param>
738-
<summary>To be added.</summary>
739-
<returns>To be added.</returns>
740-
<remarks>To be added.</remarks>
741+
<param name="name">The input string containing the name to convert.</param>
742+
<summary>Converts any escaped characters in the input type name or namespace.</summary>
743+
<returns>A string of characters with any escaped characters converted to their unescaped form.</returns>
744+
<remarks>
745+
<para>The unescaped string can be used for looking up the type name or namespace in metadata.</para>
746+
<para>This method removes escape characters even if they precede a character that does not require escaping.</para>
747+
</remarks>
741748
</Docs>
742749
</Member>
743750
<Member MemberName="WithAssemblyName">

xml/System.Reflection/ConstructorInvoker.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
<Docs>
2525
<summary>Provides methods to invoke the method specified by the provided <see cref="T:System.Reflection.ConstructorInfo" />.</summary>
2626
<remarks>This class provides better performance than <see cref="M:System.Reflection.ConstructorInfo.Invoke(System.Object[])" /> when compatibility with that method is not necessary and when the caller can cache the ConstructorInvoker instance for additional invoke calls. Unlike <see cref="M:System.Reflection.ConstructorInfo.Invoke(System.Object[])" />, the invoke methods in this class don't look up default values for arguments when <see cref="F:System.Type.Missing" /> is specified. In addition, the target constructor may be inlined for performance and not appear in stack traces.</remarks>
27+
<seealso cref="T:System.Reflection.MethodInvoker" />
2728
</Docs>
2829
<Members>
2930
<Member MemberName="Create">

xml/System.Reflection/MethodInvoker.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
<Docs>
2525
<summary>Provides methods to invoke the method specified by the provided <see cref="T:System.Reflection.MethodBase" />.</summary>
2626
<remarks>The methods in this class provide better performance than <see cref="M:System.Reflection.MethodBase.Invoke(System.Object,System.Object[])" /> when compatibility with that method isn't necessary and when the caller can cache the MethodInvoker instance for additional invoke calls. Unlike <see cref="M:System.Reflection.MethodBase.Invoke(System.Object,System.Object[])" />, the invoke methods in this class don't look up default values for arguments when <see cref="F:System.Type.Missing" /> is specified. In addition, the target method may be inlined for performance and not appear in stack traces.</remarks>
27+
<seealso cref="T:System.Reflection.ConstructorInvoker" />
2728
</Docs>
2829
<Members>
2930
<Member MemberName="Create">

0 commit comments

Comments
 (0)