From 8c3df12d441a491b5ec5edec7f12e0f167c00579 Mon Sep 17 00:00:00 2001 From: Steve Adams Date: Mon, 25 Nov 2019 12:26:28 -0800 Subject: [PATCH 1/4] add missing API refs --- xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml | 20 ++--- xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml | 76 ++++++++++--------- xml/Microsoft.VisualBasic/Collection.xml | 10 +-- xml/Microsoft.VisualBasic/MsgBoxResult.xml | 2 +- xml/Microsoft.VisualBasic/MsgBoxStyle.xml | 4 +- xml/Microsoft.VisualBasic/VbStrConv.xml | 4 +- xml/ns-IEHost.Execute.xml | 2 +- xml/ns-Microsoft.IE.xml | 2 +- xml/ns-Microsoft.VisualBasic.Vsa.xml | 2 +- 9 files changed, 62 insertions(+), 60 deletions(-) diff --git a/xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml b/xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml index fa9ac7e7f25..7f225dd72e0 100644 --- a/xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml +++ b/xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml @@ -27,7 +27,7 @@ - To be added. + Represents a code item to be compiled by the script engine. To be added. @@ -77,9 +77,9 @@ - To be added. - To be added. - To be added. + A programmatic name of the event source. + The type name of the event source. + Adds an event source to the code item. To be added. @@ -106,8 +106,8 @@ - To be added. - To be added. + The text to be appended to the code item. + Appends specified text to the end of the code item. To be added. @@ -131,7 +131,7 @@ System.CodeDom.CodeObject - To be added. + Gets the code document object model (CodeDOM) represented in the code item. To be added. To be added. @@ -159,8 +159,8 @@ - To be added. - To be added. + The programmatic name of the event source to be removed. + Removes the specified event source from the code item. To be added. @@ -184,7 +184,7 @@ System.String - To be added. + Sets or gets the text of a specified code item, including auto-generated code, if any. To be added. To be added. diff --git a/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml b/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml index 346e3846971..07649fa26a8 100644 --- a/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml +++ b/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml @@ -108,7 +108,7 @@ System.Reflection.Assembly - To be added. + Gets a reference to the running assembly generated by Run method. To be added. To be added. @@ -156,7 +156,7 @@ - To be added. + Closes the engine. To be added. @@ -181,8 +181,9 @@ - To be added. - To be added. + Causes the engine to compile the existing source state. + + on successful compilation; otherwise, . To be added. @@ -253,7 +254,7 @@ System.Security.Policy.Evidence - To be added. + Provides evidence for the purpose of validating the current object's identity. To be added. To be added. @@ -300,7 +301,7 @@ System.Boolean - To be added. + Gets or sets a Boolean value that signifies whether the script engine produces debug information when the Compile method is called. To be added. To be added. @@ -354,9 +355,9 @@ - To be added. - To be added. - To be added. + The name of the option to get. + Gets implementation-specific options for the engine. + The value of the option. To be added. @@ -381,7 +382,7 @@ - To be added. + Provides a notification that the initialization phase is complete. To be added. @@ -405,7 +406,7 @@ System.Boolean - To be added. + Gets or sets a value that indicates whether the source is compiled. To be added. To be added. @@ -430,7 +431,7 @@ System.Boolean - To be added. + Gets or sets a value that indicates whether the current in-memory representation of the item differs from the persisted representation. To be added. To be added. @@ -455,7 +456,7 @@ System.Boolean - To be added. + Gets a Boolean value that reports whether the engine is currently in run mode. To be added. To be added. @@ -483,9 +484,10 @@ - To be added. - To be added. - To be added. + A string value provided as identifier. + Checks whether the supplied identifier is valid for the engine. + + if the identifier is valid; otherwise, it returns . To be added. @@ -509,7 +511,7 @@ Microsoft.Vsa.IVsaItems - To be added. + Gets the collection of IVsaItem objects, which represent all items added to the engine. To be added. To be added. @@ -534,7 +536,7 @@ System.String - To be added. + Gets the name of the programming language supported by the engine. To be added. To be added. @@ -559,7 +561,7 @@ System.Int32 - To be added. + Gets or sets the geographical locale and language in which to report exception messages. To be added. To be added. @@ -587,8 +589,8 @@ - To be added. - To be added. + The site from which the specified source items is loaded. + Directs the engine to load source items from their point of persistence, as specified by the host-provided object. To be added. @@ -633,7 +635,7 @@ System.String - To be added. + Gets or sets the display name of the engine. To be added. To be added. @@ -659,7 +661,7 @@ - To be added. + Removes the script engine from the running state and disconnects automatically bound event handlers. To be added. @@ -684,7 +686,7 @@ - To be added. + Invalidates the cached assembly for the engine, as specified by its root moniker. To be added. @@ -708,7 +710,7 @@ System.String - To be added. + Gets or sets a script engine's root moniker. To be added. To be added. @@ -733,7 +735,7 @@ System.String - To be added. + Gets or sets the root namespace used by the engine. To be added. To be added. @@ -759,7 +761,7 @@ - To be added. + Initiates execution of compiled code in the script engine and binds all event handlers. To be added. @@ -787,9 +789,9 @@ - To be added. - To be added. - To be added. + The compiled state of the script engine. + Specifies debugging information contained in the .PDB file corresponding to the PE (portable executable). + Saves the compiled state of the script engine; optionally, it also saves debugging information. To be added. @@ -816,8 +818,8 @@ - To be added. - To be added. + The site to which source state is saved. + Directs the script engine to persist its source state. To be added. @@ -845,9 +847,9 @@ - To be added. - To be added. - To be added. + The name of the option to set. + The value for the option being set. + Sets implementation-specific options for a script engine. To be added. @@ -871,7 +873,7 @@ Microsoft.Vsa.IVsaSite - To be added. + Gets or sets the host-implemented IVsaSite object that is used by the engine to communicate with the host. To be added. To be added. @@ -896,7 +898,7 @@ System.String - To be added. + Gets the current version of the language compiler supported by the engine, in the form Major.Minor.Revision.Build. To be added. To be added. diff --git a/xml/Microsoft.VisualBasic/Collection.xml b/xml/Microsoft.VisualBasic/Collection.xml index 8b948d495a2..b56d47f6f64 100644 --- a/xml/Microsoft.VisualBasic/Collection.xml +++ b/xml/Microsoft.VisualBasic/Collection.xml @@ -902,10 +902,10 @@ MsgBox(CStr(customers(1))) - To be added. - To be added. - To be added. - To be added. + The item to add to the collection. + The item to add to the collection. + Adds an item to the collection. + The zero-based position in the collection where the item was added. To be added. @@ -1168,7 +1168,7 @@ MsgBox(CStr(customers(1))) - To be added. + The zero-based index fo the element to get or set. The zero-based index of the element to get or set. Gets or sets the element at the specified index. The element at the specified index. diff --git a/xml/Microsoft.VisualBasic/MsgBoxResult.xml b/xml/Microsoft.VisualBasic/MsgBoxResult.xml index debe59fd2c0..1fba8904297 100644 --- a/xml/Microsoft.VisualBasic/MsgBoxResult.xml +++ b/xml/Microsoft.VisualBasic/MsgBoxResult.xml @@ -186,7 +186,7 @@ 1 - To be added. + **OK** button was pressed. This member is equivalent to the Visual Basic constant . diff --git a/xml/Microsoft.VisualBasic/MsgBoxStyle.xml b/xml/Microsoft.VisualBasic/MsgBoxStyle.xml index cfbbad2fc0c..4c569da36e4 100644 --- a/xml/Microsoft.VisualBasic/MsgBoxStyle.xml +++ b/xml/Microsoft.VisualBasic/MsgBoxStyle.xml @@ -397,7 +397,7 @@ 1 - To be added. + **OK** and **Cancel** buttons. This member is equivalent to the Visual Basic constant . @@ -445,7 +445,7 @@ 0 - To be added. + **OK** button only (default). This member is equivalent to the Visual Basic constant . diff --git a/xml/Microsoft.VisualBasic/VbStrConv.xml b/xml/Microsoft.VisualBasic/VbStrConv.xml index 1ece1ba2beb..ebc8eb8b214 100644 --- a/xml/Microsoft.VisualBasic/VbStrConv.xml +++ b/xml/Microsoft.VisualBasic/VbStrConv.xml @@ -163,7 +163,7 @@ 2 - To be added. + Converts the string to lowercase characters. This member is equivalent to the Visual Basic constant . @@ -341,7 +341,7 @@ 1 - To be added. + Converts the string to uppercase characters. This member is equivalent to the Visual Basic constant . diff --git a/xml/ns-IEHost.Execute.xml b/xml/ns-IEHost.Execute.xml index 61304e1d2f0..8564ab9122f 100644 --- a/xml/ns-IEHost.Execute.xml +++ b/xml/ns-IEHost.Execute.xml @@ -1,6 +1,6 @@ - To be added. + This namespace supports the .NET Framework infrastructure and is not intended to be used directly from your code. To be added. diff --git a/xml/ns-Microsoft.IE.xml b/xml/ns-Microsoft.IE.xml index 1e02491f4cd..a38fdf75c4e 100644 --- a/xml/ns-Microsoft.IE.xml +++ b/xml/ns-Microsoft.IE.xml @@ -1,6 +1,6 @@ - To be added. + This namespace supports the .NET Framework infrastructure and is not intended to be used directly from your code. To be added. diff --git a/xml/ns-Microsoft.VisualBasic.Vsa.xml b/xml/ns-Microsoft.VisualBasic.Vsa.xml index 3fd1851c729..b6bfd50793d 100644 --- a/xml/ns-Microsoft.VisualBasic.Vsa.xml +++ b/xml/ns-Microsoft.VisualBasic.Vsa.xml @@ -1,6 +1,6 @@ - To be added. + The Microsoft.VisualBasic.Vsa namespace contains objects that allow you to integrate Script for the .NET Framework script engines into Visual Basic, and to compile and execute code at run time. To be added. From e44b840f634116c1f91be5f36b343eaafe24e88a Mon Sep 17 00:00:00 2001 From: Steve Adams Date: Thu, 5 Dec 2019 10:41:46 -0800 Subject: [PATCH 2/4] Apply suggestions from code review Suggestions from SME review Co-Authored-By: Maira Wenzel --- xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml | 6 +-- xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml | 40 ++++++++++--------- xml/Microsoft.VisualBasic/Collection.xml | 2 +- xml/ns-IEHost.Execute.xml | 3 +- xml/ns-Microsoft.IE.xml | 3 +- 5 files changed, 30 insertions(+), 24 deletions(-) diff --git a/xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml b/xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml index 7f225dd72e0..36ae1293f7b 100644 --- a/xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml +++ b/xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml @@ -107,7 +107,7 @@ The text to be appended to the code item. - Appends specified text to the end of the code item. + Appends the specified text to the end of the code item. To be added. @@ -132,7 +132,7 @@ Gets the code document object model (CodeDOM) represented in the code item. - To be added. + The CodeDOM for the code item. To be added. @@ -184,7 +184,7 @@ System.String - Sets or gets the text of a specified code item, including auto-generated code, if any. + Gets or sets the text of a specified code item, including auto-generated code, if any. To be added. To be added. diff --git a/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml b/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml index 818b23508be..4c02beee105 100644 --- a/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml +++ b/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml @@ -108,7 +108,7 @@ System.Reflection.Assembly - Gets a reference to the running assembly generated by Run method. + Gets a reference to the running assembly generated by the method. To be added. To be added. @@ -156,7 +156,7 @@ - Closes the engine. + Closes the script engine and releases all resources. If the script engine is currently running, the method is called first. To be added. @@ -181,9 +181,9 @@ - Causes the engine to compile the existing source state. + Causes the script engine to compile the existing source state. - on successful compilation; otherwise, . + on successful compilation, indicating that the method can be called on the newly compiled assembly; if the compilation failed. To be added. @@ -255,8 +255,8 @@ System.Security.Policy.Evidence - Provides evidence for the purpose of validating the current object's identity. - To be added. + Gets or sets the evidence for the purpose of validating the current object's identity. + The evidence to validate the current object's identity. To be added. @@ -302,8 +302,9 @@ System.Boolean - Gets or sets a Boolean value that signifies whether the script engine produces debug information when the Compile method is called. - To be added. + Gets or sets a value that indicates whether the script engine produces debug information when the Compile method is called. + + if the script engine produces debug information; otherwise, . To be added. @@ -407,8 +408,9 @@ System.Boolean - Gets or sets a value that indicates whether the source is compiled. - To be added. + Gets a value that indicates whether the script engine is set to produce debug information when the method is called. + + if the script engine is set to produce debug information when the method is called; otherwise, . To be added. @@ -432,8 +434,9 @@ System.Boolean - Gets or sets a value that indicates whether the current in-memory representation of the item differs from the persisted representation. - To be added. + Gets a value that indicates whether the script engine's source state has changed since the last save operation, or since the script engine was originally loaded. + + if the script engine is marked as modified (that is, "dirty"); otherwise, . The default value is . To be added. @@ -457,8 +460,9 @@ System.Boolean - Gets a Boolean value that reports whether the engine is currently in run mode. - To be added. + Gets a value that indicates whether the script engine is currently in run mode. + + if the script engine is running; otherwise, . The default value for this property is . To be added. @@ -486,9 +490,9 @@ A string value provided as identifier. - Checks whether the supplied identifier is valid for the engine. + Checks whether the supplied identifier is valid for the script engine. - if the identifier is valid; otherwise, it returns . + if the identifier is valid; otherwise, . To be added. @@ -512,8 +516,8 @@ Microsoft.Vsa.IVsaItems - Gets the collection of IVsaItem objects, which represent all items added to the engine. - To be added. + Gets the collection of objects, which represent all items added to the script engine using the CreateItem method, including code items, reference items, and global items. + A collection of all items added to the script engine using the CreateItem method, including code items, reference items, and global items. To be added. diff --git a/xml/Microsoft.VisualBasic/Collection.xml b/xml/Microsoft.VisualBasic/Collection.xml index b56d47f6f64..3e4ba3098b9 100644 --- a/xml/Microsoft.VisualBasic/Collection.xml +++ b/xml/Microsoft.VisualBasic/Collection.xml @@ -905,7 +905,7 @@ MsgBox(CStr(customers(1))) The item to add to the collection. The item to add to the collection. Adds an item to the collection. - The zero-based position in the collection where the item was added. + The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection. To be added. diff --git a/xml/ns-IEHost.Execute.xml b/xml/ns-IEHost.Execute.xml index 8564ab9122f..428249ed85b 100644 --- a/xml/ns-IEHost.Execute.xml +++ b/xml/ns-IEHost.Execute.xml @@ -1,6 +1,7 @@ - This namespace supports the .NET Framework infrastructure and is not intended to be used directly from your code. + To be added. To be added. + diff --git a/xml/ns-Microsoft.IE.xml b/xml/ns-Microsoft.IE.xml index a38fdf75c4e..a9d9a061134 100644 --- a/xml/ns-Microsoft.IE.xml +++ b/xml/ns-Microsoft.IE.xml @@ -1,6 +1,7 @@ - This namespace supports the .NET Framework infrastructure and is not intended to be used directly from your code. + To be added. To be added. + From 9e1827c2a1fc741f70d7f433eb4851b1ad37034b Mon Sep 17 00:00:00 2001 From: Steve Adams Date: Thu, 5 Dec 2019 16:03:00 -0800 Subject: [PATCH 3/4] Follow-up changes suggested by SME review --- xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml | 30 ++++++++++----------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml b/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml index 4c02beee105..feacb264e14 100644 --- a/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml +++ b/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml @@ -541,8 +541,8 @@ System.String - Gets the name of the programming language supported by the engine. - To be added. + Gets the non-localized name of the programming language supported by the script engine. + The English-language name of the programming language supported by the script engine. To be added. @@ -567,7 +567,7 @@ Gets or sets the geographical locale and language in which to report exception messages. - To be added. + An integer value representing the locale in which exception messages are to be reported. To be added. @@ -595,7 +595,7 @@ The site from which the specified source items is loaded. - Directs the engine to load source items from their point of persistence, as specified by the host-provided object. + Directs the script engine to load source items from their point of persistence, as specified by the host-provided object that implements the interface. To be added. @@ -640,8 +640,8 @@ System.String - Gets or sets the display name of the engine. - To be added. + Gets or sets the display name of the script engine that is used primarily for identifying individual script engines to users in a hosted environment. + The value of the script engine's Name property, which may be the empty string. To be added. @@ -716,7 +716,7 @@ Gets or sets a script engine's root moniker. - To be added. + The current value of the RootMoniker property. To be added. @@ -740,8 +740,8 @@ System.String - Gets or sets the root namespace used by the engine. - To be added. + Gets or sets the root namespace used by the script engine. + The string value of the root namespace. To be added. @@ -823,8 +823,8 @@ - The site to which source state is saved. - Directs the script engine to persist its source state. + The site established by the interface to which source state is saved. + Directs the script engine to persist its source state to the specified object. To be added. @@ -878,8 +878,8 @@ Microsoft.Vsa.IVsaSite - Gets or sets the host-implemented IVsaSite object that is used by the engine to communicate with the host. - To be added. + Gets or sets the host-implemented object that is used by the script engine to communicate with the host. + A reference to the current object. To be added. @@ -903,8 +903,8 @@ System.String - Gets the current version of the language compiler supported by the engine, in the form Major.Minor.Revision.Build. - To be added. + Gets the current version of the language compiler supported by the script engine, in the form Major.Minor.Revision.Build. + String value of the current version, in the format Major.Minor.Revision.Build. To be added. From 98912c27202612ae8b06637728c198d166895d55 Mon Sep 17 00:00:00 2001 From: Steve Adams Date: Tue, 10 Dec 2019 09:24:04 -0800 Subject: [PATCH 4/4] Apply suggestions from code review Co-Authored-By: Maira Wenzel --- xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml | 2 +- xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml b/xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml index 36ae1293f7b..1c182b6dbf5 100644 --- a/xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml +++ b/xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml @@ -185,7 +185,7 @@ Gets or sets the text of a specified code item, including auto-generated code, if any. - To be added. + The text of a specified code item. To be added. diff --git a/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml b/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml index feacb264e14..6ebad879097 100644 --- a/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml +++ b/xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml @@ -109,7 +109,7 @@ Gets a reference to the running assembly generated by the method. - To be added. + A reference to the running assembly generated by the method To be added.