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 2 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
20 changes: 10 additions & 10 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 specified text to the end of the code item.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -131,7 +131,7 @@
<ReturnType>System.CodeDom.CodeObject</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the code document object model (CodeDOM) represented in the code item.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -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>Sets or gets 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
76 changes: 39 additions & 37 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 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 engine.</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 engine to compile the existing source state.</summary>
<returns>
<see langword="true" /> on successful compilation; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -254,7 +255,7 @@
<ReturnType>System.Security.Policy.Evidence</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Provides evidence for the purpose of validating the current object's identity.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -301,7 +302,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a Boolean value that signifies whether the script engine produces debug information when the Compile method is called.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -355,9 +356,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 +383,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,7 +407,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a value that indicates whether the source is compiled.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -431,7 +432,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a value that indicates whether the current in-memory representation of the item differs from the persisted representation.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -456,7 +457,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets a Boolean value that reports whether the engine is currently in run mode.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -484,9 +485,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 engine.</summary>
<returns>
<see langword="true" /> if the identifier is valid; otherwise, it returns <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -510,7 +512,7 @@
<ReturnType>Microsoft.Vsa.IVsaItems</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the collection of IVsaItem objects, which represent all items added to the engine.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -535,7 +537,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the name of the programming language supported by the engine.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -560,7 +562,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the geographical locale and language in which to report exception messages.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -588,8 +590,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 engine to load source items from their point of persistence, as specified by the host-provided object.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -634,7 +636,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the display name of the engine.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -660,7 +662,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 +687,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,7 +711,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets a script engine's root moniker.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -734,7 +736,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the root namespace used by the engine.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -760,7 +762,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 +790,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 +819,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 to which source state is saved.</param>
<summary>Directs the script engine to persist its source state.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -846,9 +848,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,7 +874,7 @@
<ReturnType>Microsoft.Vsa.IVsaSite</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the host-implemented IVsaSite object that is used by the engine to communicate with the host.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -897,7 +899,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the current version of the language compiler supported by the engine, in the form <c>Major.Minor.Revision.Build</c>.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
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 zero-based position in the collection where the item was added.</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
4 changes: 2 additions & 2 deletions xml/Microsoft.VisualBasic/MsgBoxStyle.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>**OK** and **Cancel** buttons. This member is equivalent to the Visual Basic constant <see langword="vbOKCancel" />.</summary>
</Docs>
</Member>
<Member MemberName="OkOnly">
Expand Down Expand Up @@ -445,7 +445,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>**OK** button only (default). This member is equivalent to the Visual Basic constant <see langword="vbOKOnly" />.</summary>
</Docs>
</Member>
<Member MemberName="Question">
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.VisualBasic/VbStrConv.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Converts the string to lowercase characters. This member is equivalent to the Visual Basic constant <see langword="vbLowerCase" />.</summary>
</Docs>
</Member>
<Member MemberName="Narrow">
Expand Down Expand Up @@ -341,7 +341,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Converts the string to uppercase characters. This member is equivalent to the Visual Basic constant <see langword="vbUpperCase" />.</summary>
</Docs>
</Member>
<Member MemberName="Wide">
Expand Down
2 changes: 1 addition & 1 deletion xml/ns-IEHost.Execute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<Namespace Name="IEHost.Execute">
<Docs>
<summary>To be added.</summary>
<summary>This namespace supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
<remarks>To be added.</remarks>
</Docs>
</Namespace>
Loading