Skip to content

Missing API docs part 2 - SA #3567

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

Merged
merged 5 commits into from
Dec 10, 2019
Merged

Missing API docs part 2 - SA #3567

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8c3df12
add missing API refs
steveada Nov 25, 2019
109653e
Merge branch 'master' of https://github.com/dotnet/dotnet-api-docs in…
steveada Nov 25, 2019
e44b840
Apply suggestions from code review
steveada Dec 5, 2019
9e1827c
Follow-up changes suggested by SME review
steveada Dec 6, 2019
98912c2
Apply suggestions from code review
steveada Dec 10, 2019
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
22 changes: 11 additions & 11 deletions xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Represents a code item to be compiled by the script engine.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -77,9 +77,9 @@
<Parameter Name="EventSourceType" Type="System.String" />
</Parameters>
<Docs>
<param name="EventSourceName">To be added.</param>
<param name="EventSourceType">To be added.</param>
<summary>To be added.</summary>
<param name="EventSourceName">A programmatic name of the event source.</param>
<param name="EventSourceType">The type name of the event source.</param>
<summary>Adds an event source to the code item.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -106,8 +106,8 @@
<Parameter Name="Text" Type="System.String" />
</Parameters>
<Docs>
<param name="Text">To be added.</param>
<summary>To be added.</summary>
<param name="Text">The text to be appended to the code item.</param>
<summary>Appends the specified text to the end of the code item.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -131,8 +131,8 @@
<ReturnType>System.CodeDom.CodeObject</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the code document object model (CodeDOM) represented in the code item.</summary>
<value>The CodeDOM for the code item.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -159,8 +159,8 @@
<Parameter Name="EventSourceName" Type="System.String" />
</Parameters>
<Docs>
<param name="EventSourceName">To be added.</param>
<summary>To be added.</summary>
<param name="EventSourceName">The programmatic name of the event source to be removed.</param>
<summary>Removes the specified event source from the code item.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -184,7 +184,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the text of a specified code item, including auto-generated code, if any.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
106 changes: 56 additions & 50 deletions xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
<ReturnType>System.Reflection.Assembly</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets a reference to the running assembly generated by the <see cref="M:Microsoft.VisualBasic.Vsa.VsaEngine.Run" /> method.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -156,7 +156,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Closes the script engine and releases all resources. If the script engine is currently running, the <see cref="M:Microsoft.VisualBasic.Vsa.VsaEngine.Reset" /> method is called first.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -181,8 +181,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Causes the script engine to compile the existing source state.</summary>
<returns>
<see langword="true" /> on successful compilation, indicating that the <see cref="M:Microsoft.VisualBasic.Vsa.VsaEngine" /> method can be called on the newly compiled assembly; <see langword="false" /> if the compilation failed.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -254,8 +255,8 @@
<ReturnType>System.Security.Policy.Evidence</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets the evidence for the purpose of validating the current object's identity.</summary>
<value>The evidence to validate the current object's identity.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -301,8 +302,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets a value that indicates whether the script engine produces debug information when the Compile method is called.</summary>
<value>
<see langword="true" /> if the script engine produces debug information; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -355,9 +357,9 @@
<Parameter Name="Name" Type="System.String" />
</Parameters>
<Docs>
<param name="Name">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="Name">The name of the option to get.</param>
<summary>Gets implementation-specific options for the engine.</summary>
<returns>The value of the option.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -382,7 +384,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Provides a notification that the initialization phase is complete.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -406,8 +408,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a value that indicates whether the script engine is set to produce debug information when the <see cref="M:Microsoft.VisualBasic.Vsa.VsaEngine.Compile" /> method is called.</summary>
<value>
<see langword="true" /> if the script engine is set to produce debug information when the <see cref="M:Microsoft.VisualBasic.Vsa.VsaEngine.Compile" /> method is called; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -431,8 +434,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>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.</summary>
<value>
<see langword="true" /> if the script engine is marked as modified (that is, "dirty"); otherwise, <see langword="false" />. The default value is <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -456,8 +460,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a value that indicates whether the script engine is currently in run mode.</summary>
<value>
<see langword="true" /> if the script engine is running; otherwise, <see langword="false" />. The default value for this property is <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -484,9 +489,10 @@
<Parameter Name="identifier" Type="System.String" />
</Parameters>
<Docs>
<param name="identifier">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="identifier">A string value provided as identifier.</param>
<summary>Checks whether the supplied identifier is valid for the script engine.</summary>
<returns>
<see langword="true" /> if the identifier is valid; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -510,8 +516,8 @@
<ReturnType>Microsoft.Vsa.IVsaItems</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the <see cref="T:Microsoft.Vsa.IVsaItems" /> collection of <see cref="T:Microsoft.Vsa.IVsaItem" /> objects, which represent all items added to the script engine using the CreateItem method, including code items, reference items, and global items.</summary>
<value>A collection of all items added to the script engine using the CreateItem method, including code items, reference items, and global items.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -535,8 +541,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the non-localized name of the programming language supported by the script engine.</summary>
<value>The English-language name of the programming language supported by the script engine.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -560,8 +566,8 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets the geographical locale and language in which to report exception messages.</summary>
<value>An integer value representing the locale in which exception messages are to be reported.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -588,8 +594,8 @@
<Parameter Name="Site" Type="Microsoft.Vsa.IVsaPersistSite" />
</Parameters>
<Docs>
<param name="Site">To be added.</param>
<summary>To be added.</summary>
<param name="Site">The site from which the specified source items is loaded.</param>
<summary>Directs the script engine to load source items from their point of persistence, as specified by the host-provided object that implements the <see cref="T:Microsoft.Vsa.IVsaPersistSite" /> interface.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -634,8 +640,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>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.</summary>
<value>The value of the script engine's Name property, which may be the empty string.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -660,7 +666,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Removes the script engine from the running state and disconnects automatically bound event handlers.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -685,7 +691,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Invalidates the cached assembly for the engine, as specified by its root moniker.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -709,8 +715,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets a script engine's root moniker.</summary>
<value>The current value of the RootMoniker property.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -734,8 +740,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets the root namespace used by the script engine.</summary>
<value>The string value of the root namespace.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -760,7 +766,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initiates execution of compiled code in the script engine and binds all event handlers.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -788,9 +794,9 @@
<Parameter Name="PDB" Type="System.Byte[]" RefType="out" />
</Parameters>
<Docs>
<param name="PE">To be added.</param>
<param name="PDB">To be added.</param>
<summary>To be added.</summary>
<param name="PE">The compiled state of the script engine.</param>
<param name="PDB">Specifies debugging information contained in the .PDB file corresponding to the PE (portable executable).</param>
<summary>Saves the compiled state of the script engine; optionally, it also saves debugging information.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -817,8 +823,8 @@
<Parameter Name="Site" Type="Microsoft.Vsa.IVsaPersistSite" />
</Parameters>
<Docs>
<param name="Site">To be added.</param>
<summary>To be added.</summary>
<param name="Site">The site established by the <see cref="T:Microsoft.Vsa.IVsaPersistSite" /> interface to which source state is saved.</param>
<summary>Directs the script engine to persist its source state to the specified <see cref="T:Microsoft.Vsa.IVsaPersistSite" /> object.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -846,9 +852,9 @@
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<param name="Name">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<param name="Name">The name of the option to set.</param>
<param name="value">The value for the option being set.</param>
<summary>Sets implementation-specific options for a script engine.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -872,8 +878,8 @@
<ReturnType>Microsoft.Vsa.IVsaSite</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets the host-implemented <see cref="T:Microsoft.Vsa.IVsaSite" /> object that is used by the script engine to communicate with the host.</summary>
<value>A reference to the current <see cref="T:Microsoft.Vsa.IVsaSite" /> object.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -897,8 +903,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the current version of the language compiler supported by the script engine, in the form Major.Minor.Revision.Build.</summary>
<value>String value of the current version, in the format Major.Minor.Revision.Build.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 5 additions & 5 deletions xml/Microsoft.VisualBasic/Collection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -902,10 +902,10 @@ MsgBox(CStr(customers(1)))
<Parameter Name="Item" Type="System.Object" Index="0" FrameworkAlternate="netframework-1.1" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<param name="Item">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="value">The item to add to the collection.</param>
<param name="Item">The item to add to the collection.</param>
<summary>Adds an item to the collection.</summary>
<returns>The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1168,7 +1168,7 @@ MsgBox(CStr(customers(1)))
<Parameter Name="Index" Type="System.Int32" Index="0" FrameworkAlternate="netframework-1.1" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<param name="index">The zero-based index fo the element to get or set.</param>
<param name="Index">The zero-based index of the element to get or set.</param>
<summary>Gets or sets the element at the specified index.</summary>
<value>The element at the specified index.</value>
Expand Down
2 changes: 1 addition & 1 deletion xml/Microsoft.VisualBasic/MsgBoxResult.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>**OK** button was pressed. This member is equivalent to the Visual Basic constant <see langword="vbOK" />.</summary>
</Docs>
</Member>
<Member MemberName="Retry">
Expand Down
Loading