Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Port System.Reflection new docs (second pass) #10211

Merged
merged 8 commits into from
Aug 13, 2024
Merged

Port System.Reflection new docs (second pass) #10211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e7feafd
System.Reflection.
carlossanlop Aug 6, 2024
ef3b3c8
System.Reflection.Emit
carlossanlop Aug 6, 2024
7923bb3
System.Reflection.Metadata
carlossanlop Aug 6, 2024
07451bd
System.Reflecftion.PortableExecutable
carlossanlop Aug 6, 2024
76ac4af
Fix paramrefs and seealsos
carlossanlop Aug 7, 2024
b72c60f
Merge remote-tracking branch 'dotnet/main' into PortSystemReflection
carlossanlop Aug 7, 2024
8e6af4e
Fix problems in NFloat too
carlossanlop Aug 7, 2024
4935e8a
Apply suggestions from code review
carlossanlop Aug 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 76 additions & 37 deletions xml/System.Reflection.Emit/EnumBuilder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -882,8 +882,8 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>When overridden in a derived class, implements the <see cref="T:System.Type.Attributes" /> property and gets a bitwise combination of enumeration values that indicate the attributes associated with the <see cref="T:System.Type" />.</summary>
<returns>A <see cref="T:System.Reflection.TypeAttributes" /> object representing the attribute set of the <see cref="T:System.Type" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -948,13 +948,26 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr
<Parameter Name="modifiers" Type="System.Reflection.ParameterModifier[]" Index="4" FrameworkAlternate="net-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="bindingAttr">To be added.</param>
<param name="binder">To be added.</param>
<param name="callConvention">To be added.</param>
<param name="types">To be added.</param>
<param name="modifiers">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="bindingAttr">
<para>A bitwise combination of the enumeration values that specify how the search is conducted.</para>
<para>-or-</para>
<para>
<see cref="T:System.Reflection.BindingFlags.Default" /> to return <see langword="null" />.</para>
</param>
<param name="binder">
<para>An object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection.</para>
<para>-or-</para>
<para>A <see langword="null" /> reference (<see langword="Nothing" /> in Visual Basic), to use the <see cref="T:System.Type.DefaultBinder" />.</para>
</param>
<param name="callConvention">The object that specifies the set of rules to use regarding the order and layout of arguments, how the return value is passed, what registers are used for arguments, and the stack is cleaned up.</param>
<param name="types">
<para>An array of <see cref="T:System.Type" /> objects representing the number, order, and type of the parameters for the constructor to get.</para>
<para>-or-</para>
<para>An empty array of the type <see cref="T:System.Type" /> (that is, Type[] types = new Type[0]) to get a constructor that takes no parameters.</para>
</param>
<param name="modifiers">An array of <see cref="T:System.Reflection.ParameterModifier" /> objects representing the attributes associated with the corresponding element in the <paramref name="types" /> array. The default binder does not process this parameter.</param>
<summary>When overridden in a derived class, searches for a constructor whose parameters match the specified argument types and modifiers, using the specified binding constraints and the specified calling convention.</summary>
<returns>A <see cref="T:System.Reflection.ConstructorInfo" /> object representing the constructor that matches the specified requirements, if found; otherwise, <see langword="null" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -1974,14 +1987,30 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr
<Parameter Name="modifiers" Type="System.Reflection.ParameterModifier[]" Index="5" FrameworkAlternate="net-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<param name="bindingAttr">To be added.</param>
<param name="binder">To be added.</param>
<param name="callConvention">To be added.</param>
<param name="types">To be added.</param>
<param name="modifiers">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="name">The string containing the name of the method to get.</param>
<param name="bindingAttr">
<para>A bitwise combination of the enumeration values that specify how the search is conducted.</para>
<para>-or-</para>
<para>
<see cref="T:System.Reflection.BindingFlags.Default" /> to return <see langword="null" />.</para>
</param>
<param name="binder">
<para>An object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection.</para>
<para>-or-</para>
<para>A <see langword="null" /> reference (<see langword="Nothing" /> in Visual Basic), to use the <see cref="T:System.Type.DefaultBinder" />.</para>
</param>
<param name="callConvention">The object that specifies the set of rules to use regarding the order and layout of arguments, how the return value is passed, what registers are used for arguments, and what process cleans up the stack.</param>
<param name="types">
<para>An array of <see cref="T:System.Type" /> objects representing the number, order, and type of the parameters for the method to get.</para>
<para>-or-</para>
<para>An empty array of the type <see cref="T:System.Type" /> (that is, Type[] types = new Type[0]) to get a method that takes no parameters.</para>
<para>-or-</para>
<para>
<see langword="null" />. If <paramref name="types" /> is <see langword="null" />, arguments are not matched.</para>
</param>
<param name="modifiers">An array of <see cref="T:System.Reflection.ParameterModifier" /> objects representing the attributes associated with the corresponding element in the <paramref name="types" /> array. The default binder does not process this parameter.</param>
<summary>When overridden in a derived class, searches for the specified method whose parameters match the specified argument types and modifiers, using the specified binding constraints and the specified calling convention.</summary>
<returns>An object representing the method that matches the specified requirements, if found; otherwise, <see langword="null" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -2395,8 +2424,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>When overridden in a derived class, implements the <see cref="T:System.Type.HasElementType" /> property and determines whether the current <see cref="T:System.Type" /> encompasses or refers to another type; that is, whether the current <see cref="T:System.Type" /> is an array, a pointer, or is passed by reference.</summary>
<returns>
<see langword="true" /> if the <see cref="T:System.Type" /> is an array, a pointer, or is passed by reference; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -2528,8 +2558,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>When overridden in a derived class, implements the <see cref="T:System.Type.IsArray" /> property and determines whether the <see cref="T:System.Type" /> is an array.</summary>
<returns>
<see langword="true" /> if the <see cref="T:System.Type" /> is an array; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -2622,8 +2653,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>When overridden in a derived class, implements the <see cref="T:System.Type.IsByRef" /> property and determines whether the <see cref="T:System.Type" /> is passed by reference.</summary>
<returns>
<see langword="true" /> if the <see cref="T:System.Type" /> is passed by reference; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -2654,8 +2686,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a value that indicates whether the type is a byref-like structure.</summary>
<value>
<see langword="true" /> if the <see cref="T:System.Type" /> is a byref-like structure; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -2696,8 +2729,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>When overridden in a derived class, implements the <see cref="T:System.Type.IsCOMObject" /> property and determines whether the <see cref="T:System.Type" /> is a COM object.</summary>
<returns>
<see langword="true" /> if the <see cref="T:System.Type" /> is a COM object; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -2940,8 +2974,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>When overridden in a derived class, implements the <see cref="T:System.Type.IsPointer" /> property and determines whether the <see cref="T:System.Type" /> is a pointer.</summary>
<returns>
<see langword="true" /> if the <see cref="T:System.Type" /> is a pointer; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -2982,8 +3017,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>When overridden in a derived class, implements the <see cref="T:System.Type.IsPrimitive" /> property and determines whether the <see cref="T:System.Type" /> is one of the primitive types.</summary>
<returns>
<see langword="true" /> if the <see cref="T:System.Type" /> is one of the primitive types; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -3042,8 +3078,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a value that indicates whether the type is an array type that can represent only a single-dimensional array with a zero lower bound.</summary>
<value>
<see langword="true" /> if the current <see cref="T:System.Type" /> is an array type that can represent only a single-dimensional array with a zero lower bound; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -3075,8 +3112,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a value that indicates whether the type is a type definition.</summary>
<value>
<see langword="true" /> if the current <see cref="T:System.Type" /> is a type definition; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down Expand Up @@ -3117,8 +3155,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Implements the <see cref="T:System.Type.IsValueType" /> property and determines whether the <see cref="T:System.Type" /> is a value type; that is, not a class or an interface.</summary>
<returns>
<see langword="true" /> if the <see cref="T:System.Type" /> is a value type; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
Expand Down
Loading