From e7feafdc46f6dec50a66c187775aeabccc4b3f37 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez=20L=C3=B3pez?= <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 6 Aug 2024 15:55:05 -0700 Subject: [PATCH 1/7] System.Reflection. --- xml/System.Reflection/Assembly.xml | 9 ++++++--- xml/System.Reflection/ConstructorInvoker.xml | 18 +++++++++--------- xml/System.Reflection/MethodInvoker.xml | 20 ++++++++++---------- 3 files changed, 25 insertions(+), 22 deletions(-) diff --git a/xml/System.Reflection/Assembly.xml b/xml/System.Reflection/Assembly.xml index 167cd5b71a6..5d478f09233 100644 --- a/xml/System.Reflection/Assembly.xml +++ b/xml/System.Reflection/Assembly.xml @@ -6372,9 +6372,12 @@ In .NET 5 and later versions, for bundled assemblies, the value returned is an e - To be added. - To be added. - To be added. + Assembly object that represents the application's new entry assembly. + Sets the application's entry assembly to the provided assembly object. + + The assembly passed to this function has to be a runtime defined Assembly + type object. Otherwise, an exception will be thrown. + diff --git a/xml/System.Reflection/ConstructorInvoker.xml b/xml/System.Reflection/ConstructorInvoker.xml index c2fd0a10065..ebce5d2fc51 100644 --- a/xml/System.Reflection/ConstructorInvoker.xml +++ b/xml/System.Reflection/ConstructorInvoker.xml @@ -111,7 +111,7 @@ The first argument for the invoked method. Invokes the constructor using the specified arguments. - To be added. + An instance of the class associated with the constructor. To be added. The arguments do not match the signature of the invoked constructor. @@ -145,8 +145,8 @@ The arguments for the invoked constructor. - To be added. - To be added. + Invokes the constructor using the specified arguments. + An instance of the class associated with the constructor. To be added. The arguments do not match the signature of the invoked constructor. @@ -187,8 +187,8 @@ The first argument for the invoked method. The second argument for the invoked method. - To be added. - To be added. + Invokes the constructor using the specified arguments. + An instance of the class associated with the constructor. To be added. @@ -230,8 +230,8 @@ The first argument for the invoked method. The second argument for the invoked method. The third argument for the invoked method. - To be added. - To be added. + Invokes the constructor using the specified arguments. + An instance of the class associated with the constructor. To be added. @@ -275,8 +275,8 @@ The second argument for the invoked method. The third argument for the invoked method. The fourth argument for the invoked method. - To be added. - To be added. + Invokes the constructor using the specified arguments. + An instance of the class associated with the constructor. To be added. diff --git a/xml/System.Reflection/MethodInvoker.xml b/xml/System.Reflection/MethodInvoker.xml index d722205d409..78cc9a7578c 100644 --- a/xml/System.Reflection/MethodInvoker.xml +++ b/xml/System.Reflection/MethodInvoker.xml @@ -119,8 +119,8 @@ The method is not declared or inherited by the class of . The object on which to invoke the method. If the method is static, this argument is ignored. The first argument for the invoked method. - To be added. - To be added. + Invokes the method using the specified arguments. + An object containing the return value of the invoked method, or if the invoked method does not have a return value. To be added. The arguments do not match the signature of the invoked method. @@ -156,8 +156,8 @@ The method is not declared or inherited by the class of . The object on which to invoke the method. If the method is static, this argument is ignored. The arguments for the invoked method. - To be added. - To be added. + Invokes the method using the specified arguments. + An object containing the return value of the invoked method, or if the invoked method does not have a return value. To be added. The arguments do not match the signature of the invoked method. @@ -188,8 +188,8 @@ The method is not declared or inherited by the class of . The object on which to invoke the method. If the method is static, this argument is ignored. The first argument for the invoked method. The second argument for the invoked method. - To be added. - To be added. + Invokes the method using the specified arguments. + An object containing the return value of the invoked method, or if the invoked method does not have a return value. To be added. @@ -221,8 +221,8 @@ The method is not declared or inherited by the class of . The first argument for the invoked method. The second argument for the invoked method. The third argument for the invoked method. - To be added. - To be added. + Invokes the method using the specified arguments. + An object containing the return value of the invoked method, or if the invoked method does not have a return value. To be added. @@ -256,8 +256,8 @@ The method is not declared or inherited by the class of . The second argument for the invoked method. The third argument for the invoked method. The fourth argument for the invoked method. - To be added. - To be added. + Invokes the method using the specified arguments. + An object containing the return value of the invoked method, or if the invoked method does not have a return value. To be added. From ef3b3c86dd0c1374c8a14fc7d79a76e55bd181f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez=20L=C3=B3pez?= <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 6 Aug 2024 15:55:19 -0700 Subject: [PATCH 2/7] System.Reflection.Emit --- xml/System.Reflection.Emit/EnumBuilder.xml | 113 +++++++++++----- .../GenericTypeParameterBuilder.xml | 54 +++++--- xml/System.Reflection.Emit/ILGenerator.xml | 27 ++-- xml/System.Reflection.Emit/Label.xml | 2 +- xml/System.Reflection.Emit/LocalBuilder.xml | 11 +- xml/System.Reflection.Emit/ModuleBuilder.xml | 20 +-- xml/System.Reflection.Emit/OpCode.xml | 12 +- .../PersistedAssemblyBuilder.xml | 51 ++++--- xml/System.Reflection.Emit/TypeBuilder.xml | 127 ++++++++++++------ 9 files changed, 275 insertions(+), 142 deletions(-) diff --git a/xml/System.Reflection.Emit/EnumBuilder.xml b/xml/System.Reflection.Emit/EnumBuilder.xml index 8ad22f1eefa..1c9f6ef6388 100644 --- a/xml/System.Reflection.Emit/EnumBuilder.xml +++ b/xml/System.Reflection.Emit/EnumBuilder.xml @@ -882,8 +882,8 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr - To be added. - To be added. + When overridden in a derived class, implements the property and gets a bitwise combination of enumeration values that indicate the attributes associated with the . + A object representing the attribute set of the . To be added. @@ -948,13 +948,26 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + + A bitwise combination of the enumeration values that specify how the search is conducted. + -or- + + to return . + + + 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. + -or- + A reference ( in Visual Basic), to use the . + + 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. + + An array of objects representing the number, order, and type of the parameters for the constructor to get. + -or- + An empty array of the type (that is, Type[] types = new Type[0]) to get a constructor that takes no parameters. + + An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. + 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. + A object representing the constructor that matches the specified requirements, if found; otherwise, . To be added. @@ -1974,14 +1987,30 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The string containing the name of the method to get. + + A bitwise combination of the enumeration values that specify how the search is conducted. + -or- + + to return . + + + 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. + -or- + A reference ( in Visual Basic), to use the . + + 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. + + An array of objects representing the number, order, and type of the parameters for the method to get. + -or- + An empty array of the type (that is, Type[] types = new Type[0]) to get a method that takes no parameters. + -or- + + . If is , arguments are not matched. + + An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. + 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. + An object representing the method that matches the specified requirements, if found; otherwise, . To be added. @@ -2395,8 +2424,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the current encompasses or refers to another type; that is, whether the current is an array, a pointer, or is passed by reference. + + if the is an array, a pointer, or is passed by reference; otherwise, . To be added. @@ -2528,8 +2558,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is an array. + + if the is an array; otherwise, . To be added. @@ -2622,8 +2653,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is passed by reference. + + if the is passed by reference; otherwise, . To be added. @@ -2654,8 +2686,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr System.Boolean - To be added. - To be added. + Gets a value that indicates whether the type is a byref-like structure. + + if the is a byref-like structure; otherwise, . To be added. @@ -2696,8 +2729,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is a COM object. + + if the is a COM object; otherwise, . To be added. @@ -2940,8 +2974,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is a pointer. + + if the is a pointer; otherwise, . To be added. @@ -2982,8 +3017,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is one of the primitive types. + + if the is one of the primitive types; otherwise, . To be added. @@ -3042,8 +3078,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr System.Boolean - To be added. - To be added. + 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. + + if the current is an array type that can represent only a single-dimensional array with a zero lower bound; otherwise, . To be added. @@ -3075,8 +3112,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr System.Boolean - To be added. - To be added. + Gets a value that indicates whether the type is a type definition. + + if the current is a type definition; otherwise, . To be added. @@ -3117,8 +3155,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr - To be added. - To be added. + Implements the property and determines whether the is a value type; that is, not a class or an interface. + + if the is a value type; otherwise, . To be added. diff --git a/xml/System.Reflection.Emit/GenericTypeParameterBuilder.xml b/xml/System.Reflection.Emit/GenericTypeParameterBuilder.xml index 41e57f3d5da..9c5bfaf1c7d 100644 --- a/xml/System.Reflection.Emit/GenericTypeParameterBuilder.xml +++ b/xml/System.Reflection.Emit/GenericTypeParameterBuilder.xml @@ -736,8 +736,8 @@ - To be added. - To be added. + When overridden in a derived class, implements the property and gets a bitwise combination of enumeration values that indicate the attributes associated with the . + A object representing the attribute set of the . To be added. @@ -2284,8 +2284,9 @@ - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the current encompasses or refers to another type; that is, whether the current is an array, a pointer, or is passed by reference. + + if the is an array, a pointer, or is passed by reference; otherwise, . To be added. @@ -2415,8 +2416,9 @@ - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is an array. + + if the is an array; otherwise, . To be added. @@ -2589,8 +2591,9 @@ - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is passed by reference. + + if the is passed by reference; otherwise, . To be added. @@ -2621,8 +2624,9 @@ System.Boolean - To be added. - To be added. + Gets a value that indicates whether the type is a byref-like structure. + + if the is a byref-like structure; otherwise, . To be added. @@ -2662,8 +2666,9 @@ - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is a COM object. + + if the is a COM object; otherwise, . To be added. @@ -2955,8 +2960,9 @@ - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is a pointer. + + if the is a pointer; otherwise, . To be added. @@ -2996,8 +3002,9 @@ - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is one of the primitive types. + + if the is one of the primitive types; otherwise, . To be added. @@ -3113,8 +3120,9 @@ System.Boolean - To be added. - To be added. + 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. + + if the current is an array type that can represent only a single-dimensional array with a zero lower bound; otherwise, . To be added. @@ -3146,8 +3154,9 @@ System.Boolean - To be added. - To be added. + Gets a value that indicates whether the type is a type definition. + + if the current is a type definition; otherwise, . To be added. @@ -3187,8 +3196,9 @@ - To be added. - To be added. + Implements the property and determines whether the is a value type; that is, not a class or an interface. + + if the is a value type; otherwise, . To be added. diff --git a/xml/System.Reflection.Emit/ILGenerator.xml b/xml/System.Reflection.Emit/ILGenerator.xml index d6a53359115..c110c2a0839 100644 --- a/xml/System.Reflection.Emit/ILGenerator.xml +++ b/xml/System.Reflection.Emit/ILGenerator.xml @@ -517,9 +517,9 @@ - To be added. - To be added. - To be added. + The unique id for the label. + Creates a with the given id. + The created. To be added. @@ -2587,6 +2587,10 @@ The following code example emits two methods, a `varargs` method and a method th or is <= 0. This belongs to a . + + is . + + is not valid. @@ -2615,13 +2619,16 @@ The following code example emits two methods, a `varargs` method and a method th - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The document for which the sequence point is being defined. + The line where the sequence point begins. + The column in the line where the sequence point begins. + The line where the sequence point ends. + The column in the line where the sequence point ends. + When overridden in a derived class, marks a sequence point in the Microsoft intermediate language (MSIL) stream. + The parameters validated in the caller: . + + is not valid. + Emitting debug info is not supported. diff --git a/xml/System.Reflection.Emit/Label.xml b/xml/System.Reflection.Emit/Label.xml index d39eea0d96d..87418fd8ca9 100644 --- a/xml/System.Reflection.Emit/Label.xml +++ b/xml/System.Reflection.Emit/Label.xml @@ -249,7 +249,7 @@ System.Int32 - To be added. + Gets the label unique id assigned by the ILGenerator. To be added. To be added. diff --git a/xml/System.Reflection.Emit/LocalBuilder.xml b/xml/System.Reflection.Emit/LocalBuilder.xml index eecf019b51b..1947aa469ed 100644 --- a/xml/System.Reflection.Emit/LocalBuilder.xml +++ b/xml/System.Reflection.Emit/LocalBuilder.xml @@ -120,8 +120,8 @@ - To be added. - To be added. + Initializes a new instance of the class. + This constructor is invoked by derived classes. @@ -334,6 +334,7 @@ There is no symbolic writer defined for the containing module. This local is defined in a dynamic method, rather than in a method of a dynamic type. + The is . @@ -422,9 +423,11 @@ - To be added. - To be added. + The name of the local variable. + When overridden in a derived class, sets the name of this local variable. To be added. + Emitting debug info is not supported. + The containing type has been created with CreateType(). diff --git a/xml/System.Reflection.Emit/ModuleBuilder.xml b/xml/System.Reflection.Emit/ModuleBuilder.xml index 2420c55d271..0ad2a50c5aa 100644 --- a/xml/System.Reflection.Emit/ModuleBuilder.xml +++ b/xml/System.Reflection.Emit/ModuleBuilder.xml @@ -275,11 +275,14 @@ - To be added. - To be added. - To be added. - To be added. + The URL for the document. + The GUID that identifies the document language. This is optional + Defines a document for source. + The defined document. To be added. + + is . + This method is called on a dynamic module that is not a persisted module. @@ -375,11 +378,12 @@ - To be added. - To be added. - To be added. - To be added. + The URL for the document. + The GUID that identifies the document language. This is optional + When override in a derived class, defines a document for source. + The defined document. To be added. + This method is called on a dynamic module that is not a debug module. diff --git a/xml/System.Reflection.Emit/OpCode.xml b/xml/System.Reflection.Emit/OpCode.xml index 706185dfb0b..378221348b2 100644 --- a/xml/System.Reflection.Emit/OpCode.xml +++ b/xml/System.Reflection.Emit/OpCode.xml @@ -208,9 +208,17 @@ System.Int32 - To be added. + The value of how the IL instruction changes the evaluation stack. To be added. - To be added. + + The difference between how many elements are popped from the stack and how many are pushed onto the stack as a result of the IL instruction. + For some IL instructions like stack change is not fixed and depends on the called reference signature. + For such the returns 0. In this case you should not rely on + + for calculating stack size and/or max stack, instead need to evaluate the reference signature. + For example, in case the instruction is calling a method reference, need to evaluate the method signature, + the push count depends on the returning value, the pop count depends on how many parameters passed. + diff --git a/xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml b/xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml index 348466a39b4..1362ec6c367 100644 --- a/xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml +++ b/xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml @@ -24,7 +24,7 @@ - To be added. + AssemblyBuilder implementation that can persist assembly to a disk or stream. To be added. @@ -52,11 +52,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The name of the assembly. + The assembly that denotes the "system assembly" that houses the well-known types such as + A collection that contains the attributes of the assembly. + Creates a instance that can be saved to a file or stream. + Currently the persisted assembly doesn't support running, need to save it and load back to run. + The or or is . @@ -147,11 +148,13 @@ - To be added. - To be added. - To be added. - To be added. + Outputs bytes that includes all method's IL (body) emitted. + Outputs bytes that includes all field RVA data defined in the assembly. + Generates the metadata for the . + A that includes all members defined in the Assembly. To be added. + A module not defined for the assembly. + The metadata already populated for the assembly previously. @@ -181,12 +184,14 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + Outputs bytes that includes all method's IL (body) emitted. + Outputs bytes that includes all field RVA data defined in the assembly. + Outputs that includes PDB metadata. + Generates the metadata for the . + A that includes all members defined in the Assembly. To be added. + A module not defined for the assembly. + The metadata already populated for the assembly previously. @@ -306,9 +311,13 @@ - To be added. - To be added. + The to which the assembly serialized. + Serializes the assembly to . To be added. + + is . + A module not defined for the assembly. + The metadata already populated for the assembly before. @@ -330,9 +339,13 @@ - To be added. - To be added. + The file name of the assembly. + Saves the assembly to disk. To be added. + + is . + A module not defined for the assembly. + The metadata already populated for the assembly before. diff --git a/xml/System.Reflection.Emit/TypeBuilder.xml b/xml/System.Reflection.Emit/TypeBuilder.xml index 937f1a6d950..0d6150661f4 100644 --- a/xml/System.Reflection.Emit/TypeBuilder.xml +++ b/xml/System.Reflection.Emit/TypeBuilder.xml @@ -4577,8 +4577,8 @@ See for a description of the format of the - To be added. - To be added. + When overridden in a derived class, implements the property and gets a bitwise combination of enumeration values that indicate the attributes associated with the . + A object representing the attribute set of the . To be added. @@ -4725,13 +4725,26 @@ See for a description of the format of the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + + A bitwise combination of the enumeration values that specify how the search is conducted. + -or- + + to return . + + + 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. + -or- + A reference ( in Visual Basic), to use the . + + 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. + + An array of objects representing the number, order, and type of the parameters for the constructor to get. + -or- + An empty array of the type (that is, Type[] types = new Type[0]) to get a constructor that takes no parameters. + + An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. + 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. + A object representing the constructor that matches the specified requirements, if found; otherwise, . To be added. @@ -5951,14 +5964,30 @@ See for a description of the format of the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The string containing the name of the method to get. + + A bitwise combination of the enumeration values that specify how the search is conducted. + -or- + + to return . + + + 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. + -or- + A reference ( in Visual Basic), to use the . + + 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. + + An array of objects representing the number, order, and type of the parameters for the method to get. + -or- + An empty array of the type (that is, Type[] types = new Type[0]) to get a method that takes no parameters. + -or- + + . If is , arguments are not matched. + + An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. + 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. + An object representing the method that matches the specified requirements, if found; otherwise, . To be added. @@ -6276,14 +6305,27 @@ See for a description of the format of the - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The string containing the name of the property to get. + + A bitwise combination of the enumeration values that specify how the search is conducted. + -or- + + to return . + + + An object that defines a set of properties and enables binding, which can involve selection of an overloaded member, coercion of argument types, and invocation of a member through reflection. + -or- + A reference ( in Visual Basic), to use the . + + The return type of the property. + + An array of objects representing the number, order, and type of the parameters for the indexed property to get. + -or- + An empty array of the type (that is, Type[] types = new Type[0]) to get a property that is not indexed. + + An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. + When overridden in a derived class, searches for the specified property whose parameters match the specified argument types and modifiers, using the specified binding constraints. + An object representing the property that matches the specified requirements, if found; otherwise, . To be added. @@ -6372,8 +6414,9 @@ See for a description of the format of the - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the current encompasses or refers to another type; that is, whether the current is an array, a pointer, or is passed by reference. + + if the is an array, a pointer, or is passed by reference; otherwise, . To be added. @@ -6512,8 +6555,9 @@ See for a description of the format of the - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is an array. + + if the is an array; otherwise, . To be added. @@ -6674,8 +6718,9 @@ See for a description of the format of the - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is passed by reference. + + if the is passed by reference; otherwise, . To be added. @@ -6706,8 +6751,9 @@ See for a description of the format of the System.Boolean - To be added. - To be added. + Gets a value that indicates whether the type is a byref-like structure. + + if the is a byref-like structure; otherwise, . To be added. @@ -6748,8 +6794,9 @@ See for a description of the format of the - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is a COM object. + + if the is a COM object; otherwise, . To be added. @@ -7156,8 +7203,9 @@ See for a description of the format of the - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is a pointer. + + if the is a pointer; otherwise, . To be added. @@ -7198,8 +7246,9 @@ See for a description of the format of the - To be added. - To be added. + When overridden in a derived class, implements the property and determines whether the is one of the primitive types. + + if the is one of the primitive types; otherwise, . To be added. From 7923bb3254d6e8f7a6e5f6ab57de42f72cb4086e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez=20L=C3=B3pez?= <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 6 Aug 2024 15:55:33 -0700 Subject: [PATCH 3/7] System.Reflection.Metadata --- .../AssemblyNameInfo.xml | 52 +++--- xml/System.Reflection.Metadata/TypeName.xml | 159 ++++++++++++++---- .../TypeNameParseOptions.xml | 2 +- 3 files changed, 151 insertions(+), 62 deletions(-) diff --git a/xml/System.Reflection.Metadata/AssemblyNameInfo.xml b/xml/System.Reflection.Metadata/AssemblyNameInfo.xml index f5fc5686837..a970964edf5 100644 --- a/xml/System.Reflection.Metadata/AssemblyNameInfo.xml +++ b/xml/System.Reflection.Metadata/AssemblyNameInfo.xml @@ -20,8 +20,8 @@ - To be added. - To be added. + Describes an assembly. + It's a more lightweight, immutable version of that does not pre-allocate instances. @@ -63,13 +63,15 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The simple name of the assembly. + The version of the assembly. + The name of the culture associated with the assembly. + The attributes of the assembly. + The public key or its token. Set to when it's public key. + Initializes a new instance of the AssemblyNameInfo class. To be added. + + is . @@ -98,7 +100,7 @@ System.String - To be added. + Gets the name of the culture associated with the assembly. To be added. To be added. @@ -119,7 +121,7 @@ System.Reflection.AssemblyNameFlags - To be added. + Gets the attributes of the assembly. To be added. To be added. @@ -150,9 +152,9 @@ System.String - To be added. + Gets the full name of the assembly, also known as the display name. To be added. - To be added. + In contrary to it does not validate public key token neither computes it based on the provided public key. @@ -181,7 +183,7 @@ System.String - To be added. + Gets the simple name of the assembly. To be added. To be added. @@ -211,10 +213,11 @@ - To be added. - To be added. - To be added. + A span containing the characters representing the assembly name to parse. + Parses a span of characters into a assembly name. + Parsed type name. To be added. + Provided assembly name was invalid. @@ -233,9 +236,9 @@ System.Collections.Immutable.ImmutableArray<System.Byte> - To be added. + Gets the public key or the public key token of the assembly. To be added. - To be added. + Check for flag to see whether it's public key or its token. @@ -261,7 +264,7 @@ - To be added. + Initializes a new instance of the class based on the stored information. To be added. To be added. @@ -297,10 +300,11 @@ - To be added. - To be added. - To be added. - To be added. + A span containing the characters representing the assembly name to parse. + Contains the result when parsing succeeds. + Tries to parse a span of characters into an assembly name. + + if assembly name was converted successfully, otherwise, . To be added. @@ -330,7 +334,7 @@ System.Version - To be added. + Gets the version of the assembly. To be added. To be added. diff --git a/xml/System.Reflection.Metadata/TypeName.xml b/xml/System.Reflection.Metadata/TypeName.xml index 8749624da79..954e27ba624 100644 --- a/xml/System.Reflection.Metadata/TypeName.xml +++ b/xml/System.Reflection.Metadata/TypeName.xml @@ -58,7 +58,10 @@ System.Reflection.Metadata.AssemblyNameInfo - To be added. + + Returns assembly name which contains this type, or if this was not + created from a fully-qualified name. + To be added. To be added. @@ -79,9 +82,9 @@ System.String - To be added. + The assembly-qualified name of the type; e.g., "System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089". To be added. - To be added. + If returns , simply returns . @@ -100,9 +103,13 @@ System.Reflection.Metadata.TypeName - To be added. + + If this type is a nested type (see ), gets + the declaring type. If this type is not a nested type, throws. + To be added. - To be added. + For example, given "Namespace.Declaring+Nested", unwraps the outermost type and returns "Namespace.Declaring". + The current type is not a nested type. @@ -121,9 +128,21 @@ System.String - To be added. + + The full name of this type, including namespace, but without the assembly name; e.g., "System.Int32". + Nested types are represented with a '+'; e.g., "MyNamespace.MyType+NestedType". + To be added. - To be added. + + For constructed generic types, the type arguments will be listed using their fully qualified + names. For example, given "List<int>", the property will return + "System.Collections.Generic.List`1[[System.Int32, mscorlib, ...]]". + For open generic types, the convention is to use a backtick ("`") followed by + the arity of the generic type. For example, given "Dictionary<,>", the + property will return "System.Collections.Generic.Dictionary`2". Given "Dictionary<,>.Enumerator", + the property will return "System.Collections.Generic.Dictionary`2+Enumerator". + See ECMA-335, Sec. I.10.7.2 (Type names and arity encoding) for more information. + @@ -143,9 +162,10 @@ - To be added. - To be added. + Gets the number of dimensions in an array. + An integer that contains the number of dimensions in the current type. To be added. + The current type is not an array. @@ -165,9 +185,10 @@ - To be added. + The TypeName of the object encompassed or referred to by the current array, pointer, or reference type. To be added. - To be added. + For example, given "int[][]", unwraps the outermost array and returns "int[]". + The current type is not an array, pointer or reference. @@ -193,9 +214,15 @@ - To be added. + + If this represents a constructed generic type, returns an array + of all the generic arguments. Otherwise it returns an empty array. + To be added. - To be added. + + For example, given "Dictionary<string, int>", returns a 2-element array containing + string and int. + @@ -215,9 +242,10 @@ - To be added. + Returns a TypeName object that represents a generic type name definition from which the current generic type name can be constructed. To be added. - To be added. + Given "Dictionary<string, int>", returns the generic type definition "Dictionary<,>". + The current type is not a generic type. @@ -237,9 +265,35 @@ - To be added. + + Represents the total number of instances that are used to describe + this instance, including any generic arguments or underlying types. + To be added. - To be added. + + 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 instances that would be created if + you were to totally deconstruct this instance and visit each intermediate + 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, plus unwrapping the underlying type ("int") and inspecting that. + "Dictionary<string, List<int[][]>>" has node count 8 because fully visiting it + involves inspecting 8 instances total: + + + Dictionary<string, List<int[][]>> (the original type) + Dictionary`2 (the generic type definition) + string (a type argument of Dictionary) + List<int[][]> (a type argument of Dictionary) + List`1 (the generic type definition) + int[][] (a type argument of List) + int[] (the underlying type of int[][]) + int (the underlying type of int[]) + + + @@ -258,7 +312,10 @@ System.Boolean - To be added. + + Returns if this type represents any kind of array, regardless of the array's + rank or its bounds. + To be added. To be added. @@ -279,7 +336,10 @@ System.Boolean - To be added. + + Returns if this is a managed pointer type (e.g., "ref int"). + Managed pointer types are sometimes called byref types () + To be added. To be added. @@ -300,9 +360,9 @@ System.Boolean - To be added. + Returns if this type represents a constructed generic type (e.g., "List<int>"). To be added. - To be added. + Returns for open generic types (e.g., "Dictionary<,>"). @@ -321,7 +381,10 @@ System.Boolean - To be added. + + Returns if this is a nested type (e.g., "Namespace.Declaring+Nested"). + For nested types returns their declaring type. + To be added. To be added. @@ -342,7 +405,10 @@ System.Boolean - To be added. + + Returns if this type represents an unmanaged pointer (e.g., "int*" or "void*"). + Unmanaged pointer types are often just called pointers () + To be added. To be added. @@ -363,9 +429,19 @@ System.Boolean - To be added. + + Returns if 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". + To be added. - To be added. + + This property returning 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 for generic type definitions (e.g., "Dictionary<,>"). + This is because determining whether a type truly is a generic type requires loading the type + and performing a runtime check. + @@ -384,7 +460,7 @@ System.Boolean - To be added. + Returns if this type represents a single-dimensional, zero-indexed array (e.g., "int[]"). To be added. To be added. @@ -405,7 +481,10 @@ System.Boolean - To be added. + + Returns if this type represents a variable-bound array; that is, an array of rank greater + than 1 (e.g., "int[,]") or a single-dimensional array which isn't necessarily zero-indexed. + To be added. To be added. @@ -426,7 +505,10 @@ System.String - To be added. + + The name of this type, without the namespace and the assembly name; e.g., "Int32". + Nested types are represented without a '+'; e.g., "MyNamespace.MyType+NestedType" is just "NestedType". + To be added. To be added. @@ -469,11 +551,13 @@ - To be added. - To be added. - To be added. - To be added. + A span containing the characters representing the type name to parse. + An object that describes optional parameters to use. + Parses a span of characters into a type name. + Parsed type name. To be added. + Provided type name was invalid. + Parsing has exceeded the limit set by . @@ -516,11 +600,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + A span containing the characters representing the type name to parse. + Contains the result when parsing succeeds. + An object that describes optional parameters to use. + Tries to parse a span of characters into a type name. + + if type name was converted successfully, otherwise, . To be added. diff --git a/xml/System.Reflection.Metadata/TypeNameParseOptions.xml b/xml/System.Reflection.Metadata/TypeNameParseOptions.xml index 3a29a3b962c..eabdf58fe6a 100644 --- a/xml/System.Reflection.Metadata/TypeNameParseOptions.xml +++ b/xml/System.Reflection.Metadata/TypeNameParseOptions.xml @@ -51,7 +51,7 @@ System.Int32 - To be added. + Limits the maximum value of <see cref="M:System.Reflection.Metadata.TypeName.GetNodeCount">node count</seealso> that parser can handle. To be added. To be added. From 07451bd0aa8a581b7b2448ee1040ef74faba0ba7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez=20L=C3=B3pez?= <1175054+carlossanlop@users.noreply.github.com> Date: Tue, 6 Aug 2024 15:55:49 -0700 Subject: [PATCH 4/7] System.Reflecftion.PortableExecutable --- xml/System.Reflection.PortableExecutable/Machine.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System.Reflection.PortableExecutable/Machine.xml b/xml/System.Reflection.PortableExecutable/Machine.xml index 28a8b1d3d7a..d3351967833 100644 --- a/xml/System.Reflection.PortableExecutable/Machine.xml +++ b/xml/System.Reflection.PortableExecutable/Machine.xml @@ -547,7 +547,7 @@ 20776 - To be added. + RISCV128 @@ -567,7 +567,7 @@ 20530 - To be added. + RISCV32 @@ -587,7 +587,7 @@ 20580 - To be added. + RISCV64 From 76ac4af41fea533d61bb606ef2505eafcfc4a826 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez=20L=C3=B3pez?= <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 7 Aug 2024 12:15:22 -0700 Subject: [PATCH 5/7] Fix paramrefs and seealsos --- xml/System.Reflection.Emit/EnumBuilder.xml | 6 +++--- xml/System.Reflection.Emit/TypeBuilder.xml | 8 ++++---- xml/System.Reflection.Metadata/AssemblyNameInfo.xml | 8 ++++---- xml/System.Reflection.Metadata/TypeName.xml | 6 +++--- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/xml/System.Reflection.Emit/EnumBuilder.xml b/xml/System.Reflection.Emit/EnumBuilder.xml index 1c9f6ef6388..719098dfbf2 100644 --- a/xml/System.Reflection.Emit/EnumBuilder.xml +++ b/xml/System.Reflection.Emit/EnumBuilder.xml @@ -965,7 +965,7 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr -or- An empty array of the type (that is, Type[] types = new Type[0]) to get a constructor that takes no parameters. - An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. + An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. 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. A object representing the constructor that matches the specified requirements, if found; otherwise, . To be added. @@ -2006,9 +2006,9 @@ The following code sample demonstrates the use of the `AssemblyQualifiedName` pr An empty array of the type (that is, Type[] types = new Type[0]) to get a method that takes no parameters. -or- - . If is , arguments are not matched. + . If is , arguments are not matched. - An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. + An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. 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. An object representing the method that matches the specified requirements, if found; otherwise, . To be added. diff --git a/xml/System.Reflection.Emit/TypeBuilder.xml b/xml/System.Reflection.Emit/TypeBuilder.xml index 0d6150661f4..7ec2570a7ad 100644 --- a/xml/System.Reflection.Emit/TypeBuilder.xml +++ b/xml/System.Reflection.Emit/TypeBuilder.xml @@ -4742,7 +4742,7 @@ See for a description of the format of the -or- An empty array of the type (that is, Type[] types = new Type[0]) to get a constructor that takes no parameters. - An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. + An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. 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. A object representing the constructor that matches the specified requirements, if found; otherwise, . To be added. @@ -5983,9 +5983,9 @@ See for a description of the format of the An empty array of the type (that is, Type[] types = new Type[0]) to get a method that takes no parameters. -or- - . If is , arguments are not matched. + . If is , arguments are not matched. - An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. + An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. 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. An object representing the method that matches the specified requirements, if found; otherwise, . To be added. @@ -6323,7 +6323,7 @@ See for a description of the format of the -or- An empty array of the type (that is, Type[] types = new Type[0]) to get a property that is not indexed. - An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. + An array of objects representing the attributes associated with the corresponding element in the array. The default binder does not process this parameter. When overridden in a derived class, searches for the specified property whose parameters match the specified argument types and modifiers, using the specified binding constraints. An object representing the property that matches the specified requirements, if found; otherwise, . To be added. diff --git a/xml/System.Reflection.Metadata/AssemblyNameInfo.xml b/xml/System.Reflection.Metadata/AssemblyNameInfo.xml index a970964edf5..17273f5d03b 100644 --- a/xml/System.Reflection.Metadata/AssemblyNameInfo.xml +++ b/xml/System.Reflection.Metadata/AssemblyNameInfo.xml @@ -21,7 +21,7 @@ Describes an assembly. - It's a more lightweight, immutable version of that does not pre-allocate instances. + It's a more lightweight, immutable version of that does not pre-allocate instances. @@ -67,7 +67,7 @@ The version of the assembly. The name of the culture associated with the assembly. The attributes of the assembly. - The public key or its token. Set to when it's public key. + The public key or its token. Set to when it's public key. Initializes a new instance of the AssemblyNameInfo class. To be added. @@ -154,7 +154,7 @@ Gets the full name of the assembly, also known as the display name. To be added. - In contrary to it does not validate public key token neither computes it based on the provided public key. + In contrary to it does not validate public key token neither computes it based on the provided public key. @@ -238,7 +238,7 @@ Gets the public key or the public key token of the assembly. To be added. - Check for flag to see whether it's public key or its token. + Check for flag to see whether it's public key or its token. diff --git a/xml/System.Reflection.Metadata/TypeName.xml b/xml/System.Reflection.Metadata/TypeName.xml index 954e27ba624..c9a24997c84 100644 --- a/xml/System.Reflection.Metadata/TypeName.xml +++ b/xml/System.Reflection.Metadata/TypeName.xml @@ -552,12 +552,12 @@ A span containing the characters representing the type name to parse. - An object that describes optional parameters to use. + An object that describes optional parameters to use. Parses a span of characters into a type name. Parsed type name. To be added. Provided type name was invalid. - Parsing has exceeded the limit set by . + Parsing has exceeded the limit set by . @@ -602,7 +602,7 @@ A span containing the characters representing the type name to parse. Contains the result when parsing succeeds. - An object that describes optional parameters to use. + An object that describes optional parameters to use. Tries to parse a span of characters into a type name. if type name was converted successfully, otherwise, . From 8e6af4e260c80218da8710c761baafd1215312f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez=20L=C3=B3pez?= <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 7 Aug 2024 12:53:00 -0700 Subject: [PATCH 6/7] Fix problems in NFloat too --- xml/System.Runtime.InteropServices/NFloat.xml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/xml/System.Runtime.InteropServices/NFloat.xml b/xml/System.Runtime.InteropServices/NFloat.xml index 3edd6157dda..adda2d7805e 100644 --- a/xml/System.Runtime.InteropServices/NFloat.xml +++ b/xml/System.Runtime.InteropServices/NFloat.xml @@ -1435,7 +1435,7 @@ This computes `cos(x * π)`. The value to convert to radians. Converts a given value from degrees to radians. - The value of converted to radians. + The value of converted to radians. To be added. @@ -4980,10 +4980,10 @@ For this method matches the IEEE 754:2 The span of UTF-8 characters to parse. - A bitwise combination of number styles that can be present in . - An object that provides culture-specific formatting information about . + A bitwise combination of number styles that can be present in . + An object that provides culture-specific formatting information about . Parses a span of UTF-8 characters into a value. - The result of parsing . + The result of parsing . To be added. @@ -5205,7 +5205,7 @@ For this method matches the IEEE 754:2 The value to convert to degrees. Converts a given value from radians to degrees. - The value of converted to degrees. + The value of converted to degrees. To be added. @@ -7605,12 +7605,12 @@ This computes `tan(x * π)`. The span of UTF-8 characters to parse. - A bitwise combination of number styles that can be present in . - An object that provides culture-specific formatting information about . - On return, contains the result of successfully parsing or an undefined value on failure. + A bitwise combination of number styles that can be present in . + An object that provides culture-specific formatting information about . + On return, contains the result of successfully parsing or an undefined value on failure. Tries to parse a span of UTF-8 characters into a value. - if was successfully parsed; otherwise, . + if was successfully parsed; otherwise, . To be added. From 4935e8a37ec0c5f8044752b5fd12bf4d2d6565c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20S=C3=A1nchez=20L=C3=B3pez?= <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 12 Aug 2024 21:44:40 -0700 Subject: [PATCH 7/7] Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Reflection.Emit/ILGenerator.xml | 4 +- xml/System.Reflection.Emit/ModuleBuilder.xml | 4 +- xml/System.Reflection.Emit/OpCode.xml | 4 +- .../PersistedAssemblyBuilder.xml | 22 ++++----- .../AssemblyNameInfo.xml | 6 +-- xml/System.Reflection.Metadata/TypeName.xml | 48 +++++++++---------- .../TypeNameParseOptions.xml | 2 +- 7 files changed, 45 insertions(+), 45 deletions(-) diff --git a/xml/System.Reflection.Emit/ILGenerator.xml b/xml/System.Reflection.Emit/ILGenerator.xml index c110c2a0839..b733f8079da 100644 --- a/xml/System.Reflection.Emit/ILGenerator.xml +++ b/xml/System.Reflection.Emit/ILGenerator.xml @@ -517,8 +517,8 @@ - The unique id for the label. - Creates a with the given id. + The unique ID for the label. + Creates a with the given ID. The created. To be added. diff --git a/xml/System.Reflection.Emit/ModuleBuilder.xml b/xml/System.Reflection.Emit/ModuleBuilder.xml index 0ad2a50c5aa..aa442dcd79c 100644 --- a/xml/System.Reflection.Emit/ModuleBuilder.xml +++ b/xml/System.Reflection.Emit/ModuleBuilder.xml @@ -276,7 +276,7 @@ The URL for the document. - The GUID that identifies the document language. This is optional + The GUID that identifies the document language. This is optional. Defines a document for source. The defined document. To be added. @@ -379,7 +379,7 @@ The URL for the document. - The GUID that identifies the document language. This is optional + The GUID that identifies the document language. This is optional. When override in a derived class, defines a document for source. The defined document. To be added. diff --git a/xml/System.Reflection.Emit/OpCode.xml b/xml/System.Reflection.Emit/OpCode.xml index 378221348b2..727dbcfcb25 100644 --- a/xml/System.Reflection.Emit/OpCode.xml +++ b/xml/System.Reflection.Emit/OpCode.xml @@ -208,7 +208,7 @@ System.Int32 - The value of how the IL instruction changes the evaluation stack. + Gets the value of how the IL instruction changes the evaluation stack. To be added. The difference between how many elements are popped from the stack and how many are pushed onto the stack as a result of the IL instruction. @@ -216,7 +216,7 @@ For such the returns 0. In this case you should not rely on for calculating stack size and/or max stack, instead need to evaluate the reference signature. - For example, in case the instruction is calling a method reference, need to evaluate the method signature, + For example, in case the instruction is calling a method reference, you need to evaluate the method signature; the push count depends on the returning value, the pop count depends on how many parameters passed. diff --git a/xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml b/xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml index 1362ec6c367..93dc197061d 100644 --- a/xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml +++ b/xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml @@ -24,7 +24,7 @@ - AssemblyBuilder implementation that can persist assembly to a disk or stream. + Provides an AssemblyBuilder implementation that can persist assembly to a disk or stream. To be added. @@ -56,7 +56,7 @@ The assembly that denotes the "system assembly" that houses the well-known types such as A collection that contains the attributes of the assembly. Creates a instance that can be saved to a file or stream. - Currently the persisted assembly doesn't support running, need to save it and load back to run. + Currently the persisted assembly doesn't support running. You must save it and load it back to run. The or or is . @@ -148,13 +148,13 @@ - Outputs bytes that includes all method's IL (body) emitted. - Outputs bytes that includes all field RVA data defined in the assembly. + When this method returns, contains the bytes that includes all method's IL (body) emitted. + When this method returns, contains the bytes that includes all field RVA data defined in the assembly. Generates the metadata for the . A that includes all members defined in the Assembly. To be added. - A module not defined for the assembly. - The metadata already populated for the assembly previously. + A module is not defined for the assembly. + The metadata was previously populated for the assembly. @@ -184,9 +184,9 @@ - Outputs bytes that includes all method's IL (body) emitted. - Outputs bytes that includes all field RVA data defined in the assembly. - Outputs that includes PDB metadata. + When this method returns, contains the bytes that includes all method's IL (body) emitted. + When this method returns, contains the bytes that includes all field RVA data defined in the assembly. + When this method returns, contains the that includes PDB metadata. Generates the metadata for the . A that includes all members defined in the Assembly. To be added. @@ -311,8 +311,8 @@ - The to which the assembly serialized. - Serializes the assembly to . + The to which the assembly should be serialized. + Serializes the assembly to the specified stream. To be added. is . diff --git a/xml/System.Reflection.Metadata/AssemblyNameInfo.xml b/xml/System.Reflection.Metadata/AssemblyNameInfo.xml index 17273f5d03b..a916856d84c 100644 --- a/xml/System.Reflection.Metadata/AssemblyNameInfo.xml +++ b/xml/System.Reflection.Metadata/AssemblyNameInfo.xml @@ -154,7 +154,7 @@ Gets the full name of the assembly, also known as the display name. To be added. - In contrary to it does not validate public key token neither computes it based on the provided public key. + In contrast to , this property doesn't validate the public key token or compute it based on the provided public key. @@ -217,7 +217,7 @@ Parses a span of characters into a assembly name. Parsed type name. To be added. - Provided assembly name was invalid. + The provided assembly name is invalid. @@ -238,7 +238,7 @@ Gets the public key or the public key token of the assembly. To be added. - Check for flag to see whether it's public key or its token. + Check for flag to determine whether it's a public key or its token. diff --git a/xml/System.Reflection.Metadata/TypeName.xml b/xml/System.Reflection.Metadata/TypeName.xml index c9a24997c84..c3d6aade49a 100644 --- a/xml/System.Reflection.Metadata/TypeName.xml +++ b/xml/System.Reflection.Metadata/TypeName.xml @@ -59,8 +59,8 @@ - Returns assembly name which contains this type, or if this was not - created from a fully-qualified name. + Returns assembly name that contains this type, or if this was not + created from a fully qualified name. To be added. To be added. @@ -82,7 +82,7 @@ System.String - The assembly-qualified name of the type; e.g., "System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089". + Gets the assembly-qualified name of the type; for example, "System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089". To be added. If returns , simply returns . @@ -108,7 +108,7 @@ the declaring type. If this type is not a nested type, throws. To be added. - For example, given "Namespace.Declaring+Nested", unwraps the outermost type and returns "Namespace.Declaring". + For example, given "Namespace.Declaring+Nested", this property unwraps the outermost type and returns "Namespace.Declaring". The current type is not a nested type. @@ -129,8 +129,8 @@ - The full name of this type, including namespace, but without the assembly name; e.g., "System.Int32". - Nested types are represented with a '+'; e.g., "MyNamespace.MyType+NestedType". + Gets the full name of this type, including namespace, but without the assembly name; for example, "System.Int32". + Nested types are represented with a '+'; for example, "MyNamespace.MyType+NestedType". To be added. @@ -185,7 +185,7 @@ - The TypeName of the object encompassed or referred to by the current array, pointer, or reference type. + Gets the TypeName of the object encompassed or referred to by the current array, pointer, or reference type. To be added. For example, given "int[][]", unwraps the outermost array and returns "int[]". The current type is not an array, pointer or reference. @@ -244,7 +244,7 @@ Returns a TypeName object that represents a generic type name definition from which the current generic type name can be constructed. To be added. - Given "Dictionary<string, int>", returns the generic type definition "Dictionary<,>". + Given "Dictionary<string, int>", this method returns the generic type definition "Dictionary<,>". The current type is not a generic type. @@ -266,7 +266,7 @@ - Represents the total number of instances that are used to describe + Gets the total number of instances that are used to describe this instance, including any generic arguments or underlying types. To be added. @@ -313,7 +313,7 @@ - Returns if this type represents any kind of array, regardless of the array's + Gets a value that indicates whether this type represents any kind of array, regardless of the array's rank or its bounds. To be added. @@ -337,8 +337,8 @@ - Returns if this is a managed pointer type (e.g., "ref int"). - Managed pointer types are sometimes called byref types () + Gets a value that indicates whether this is a managed pointer type (for example, "ref int"). + Managed pointer types are sometimes called byref types (). To be added. To be added. @@ -360,9 +360,9 @@ System.Boolean - Returns if this type represents a constructed generic type (e.g., "List<int>"). + Gets a value that indicates whether this type represents a constructed generic type (for example, "List<int>"). To be added. - Returns for open generic types (e.g., "Dictionary<,>"). + Returns for open generic types (for example, "Dictionary<,>"). @@ -382,7 +382,7 @@ - Returns if this is a nested type (e.g., "Namespace.Declaring+Nested"). + Gets a value that indicates whether this is a nested type (for example, "Namespace.Declaring+Nested"). For nested types returns their declaring type. To be added. @@ -406,8 +406,8 @@ - Returns if this type represents an unmanaged pointer (e.g., "int*" or "void*"). - Unmanaged pointer types are often just called pointers () + 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 (). To be added. To be added. @@ -430,7 +430,7 @@ - Returns if this is a "plain" type; that is, not an array, not a pointer, not a reference, and + 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". @@ -438,7 +438,7 @@ This property returning 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 for generic type definitions (e.g., "Dictionary<,>"). + This property will return for generic type definitions (for example, "Dictionary<,>"). This is because determining whether a type truly is a generic type requires loading the type and performing a runtime check. @@ -460,7 +460,7 @@ System.Boolean - Returns if this type represents a single-dimensional, zero-indexed array (e.g., "int[]"). + Gets a value that indicates whether this type represents a single-dimensional, zero-indexed array (for example, "int[]"). To be added. To be added. @@ -482,8 +482,8 @@ - Returns if this type represents a variable-bound array; that is, an array of rank greater - than 1 (e.g., "int[,]") or a single-dimensional array which isn't necessarily zero-indexed. + 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. To be added. To be added. @@ -506,8 +506,8 @@ - The name of this type, without the namespace and the assembly name; e.g., "Int32". - Nested types are represented without a '+'; e.g., "MyNamespace.MyType+NestedType" is just "NestedType". + 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". To be added. To be added. diff --git a/xml/System.Reflection.Metadata/TypeNameParseOptions.xml b/xml/System.Reflection.Metadata/TypeNameParseOptions.xml index eabdf58fe6a..443cb34f272 100644 --- a/xml/System.Reflection.Metadata/TypeNameParseOptions.xml +++ b/xml/System.Reflection.Metadata/TypeNameParseOptions.xml @@ -51,7 +51,7 @@ System.Int32 - Limits the maximum value of <see cref="M:System.Reflection.Metadata.TypeName.GetNodeCount">node count</seealso> that parser can handle. + Limits the maximum number of nodes that the parser can handle. To be added. To be added.