Skip to content

Add missing API docs part 11 - SA #3747

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
Jan 11, 2020
Merged

Add missing API docs part 11 - SA #3747

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
124d47d
add missing items
steveada Jan 8, 2020
0fde7f9
Merge branch 'master' of https://github.com/dotnet/dotnet-api-docs in…
steveada Jan 8, 2020
a552fe9
add out description
mairaw Jan 10, 2020
70aaaa9
small edits
mairaw Jan 10, 2020
da6e057
fix broken link
mairaw Jan 10, 2020
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
45 changes: 30 additions & 15 deletions xml/Microsoft.CLRAdmin/CData.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,12 +193,18 @@
<Parameter Name="lpIDataObject" Type="Microsoft.CLRAdmin.IDataObject" />
</Parameters>
<Docs>
<param name="lpProvider">To be added.</param>
<param name="handle">To be added.</param>
<param name="lpIDataObject">To be added.</param>
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
<returns>To be added.</returns>
<param name="lpProvider">A pointer to the <see cref="T:Microsoft.CLRAdmin.IPropertySheetCallback" />.</param>
<param name="handle">The handle to use to route the notification message to the appropriate <see cref="T:Microsoft.CLRAdmin.IComponent" /> or <see cref="T:Microsoft.CLRAdmin.IComponentData" />.</param>
<param name="lpIDataObject">A pointer to the <see cref="T:Microsoft.CLRAdmin.IDataObject" /> on the object containing context information about the scope or result item.</param>
<summary>Adds pages to a property sheet.</summary>
<returns>| Return Value | Description |
| --- | --- |
| S\_OK | The <see cref="M:Microsoft.CLRAdmin.CData.CreatePropertyPages(Microsoft.CLRAdmin.IPropertySheetCallback,System.IntPtr,Microsoft.CLRAdmin.IDataObject)" /> method successfully added the property sheet pages. |
| S\_FALSE | The <see cref="M:Microsoft.CLRAdmin.CData.CreatePropertyPages(Microsoft.CLRAdmin.IPropertySheetCallback,System.IntPtr,Microsoft.CLRAdmin.IDataObject)" /> method added no property sheet pages. |
| E\_UNEXPECTED | An unexpected error occurred. |
| E\_INVALIDARG | One or more parameters are not valid. |</returns>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="Destroy">
Expand Down Expand Up @@ -278,14 +284,17 @@
<Parameter Name="bStretch" Type="System.Int32" RefType="out" />
</Parameters>
<Docs>
<param name="lpIDataObject">To be added.</param>
<param name="lphWatermark">To be added.</param>
<param name="lphHeader">To be added.</param>
<param name="lphPalette">To be added.</param>
<param name="bStretch">To be added.</param>
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
<returns>To be added.</returns>
<param name="lpIDataObject">The <see cref="T:Microsoft.CLRAdmin.IDataObject" /> on the object containing context information about the scope or result item.</param>
<param name="lphWatermark">When this method returns, the handle to a bitmap that serves as the watermark for Wizard 97 pages.</param>
<param name="lphHeader">When this method returns, the handle to a bitmap that serves as the header for Wizard 97 pages.</param>
<param name="lphPalette">When this method returns, the handle to a palette used for the bitmaps specified by <paramref name="lphWatermark" /> and <paramref name="lphHeader" />.</param>
<param name="bStretch">When this method returns, <see langword="true" /> if the watermark and header bitmaps should be stretched rather than tiled; otherwise, <see langword="false" />.</param>
<summary>Retrieves the watermark and header bitmaps for wizard sheets that are implemented as Wizard 97-style wizards.</summary>
<returns>| Return Value | Description |
| --- | --- |
| etch | <see langword="true" /> if the watermark and header bitmaps should be stretched rather than tiled; otherwise, <see langword="false" />. |</returns>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
<Member MemberName="Initialize">
Expand Down Expand Up @@ -402,10 +411,16 @@
<Parameter Name="lpDataObject" Type="Microsoft.CLRAdmin.IDataObject" />
</Parameters>
<Docs>
<param name="lpDataObject">To be added.</param>
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
<returns>To be added.</returns>
<param name="lpDataObject">A pointer to the <see cref="T:Microsoft.CLRAdmin.IDataObject" /> on the object containing context information about the scope or result item.</param>
<summary>Determines whether the object requires pages.</summary>
<returns>| Return value | Description |
| --- | --- |
| S\_OK | Properties exist for this data object. |
| E\_UNEXPECTED | An unexpected error occurred. |
| E\_INVALID | The parameter is not valid. |
| Any other error code | No pages are supplied for the data object. |</returns>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
</Member>
</Members>
Expand Down
16 changes: 8 additions & 8 deletions xml/Microsoft.JScript.Vsa/VsaEngine.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -632,9 +632,9 @@
<Parameter Name="itemName" Type="System.String" Index="0" FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8" />
</Parameters>
<Docs>
<param name="itemName">To be added.</param>
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
<returns>To be added.</returns>
<param name="itemName">The name of the item to get.</param>
<summary>Gets the item from the scope that is designated by the specified name.</summary>
<returns>The item that is named by <paramref name="itemName" />.</returns>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
Expand All @@ -658,9 +658,9 @@
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
<returns>To be added.</returns>
<param name="index">The index of the item to get.</param>
<summary>Gets the item from the scope that is designated by the specified index value.</summary>
<returns>The item at <paramref name="index" />.</returns>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
Expand All @@ -684,8 +684,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
<returns>To be added.</returns>
<summary>Gets the number of items in the scope.</summary>
<returns>The number of items in the scope.</returns>
<remarks>To be added.</remarks>
<forInternalUseOnly />
</Docs>
Expand Down
38 changes: 19 additions & 19 deletions xml/Microsoft.VisualBasic.Vsa/VsaCompilerError.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Represents a compiler error or warning.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -48,8 +48,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a brief description of the error.</summary>
<value>A string description of the error.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -73,8 +73,8 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the ending column number for the source text that caused the error, if available.</summary>
<value>The ending column number for the source text that caused the error, if available.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -98,8 +98,8 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the line number on which an error occurs.</summary>
<value>The line number on which the error has occurred.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -123,8 +123,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the text of the source code from the line that caused the error.</summary>
<value>The source code from the line that caused the error.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -148,8 +148,8 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a number that uniquely identifies the error.</summary>
<value>The number that uniquely identifies the error.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -173,8 +173,8 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the severity of the error.</summary>
<value>An integer (0-4) that represents the error severity.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -198,8 +198,8 @@
<ReturnType>Microsoft.Vsa.IVsaItem</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a reference to the <see cref="T:Microsoft.VisualBasic.Vsa.IVsaItem" /> object that generated the error.</summary>
<value>A reference to the object that generated the error.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -223,8 +223,8 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the fully qualified name of the source item that contained the error.</summary>
<value>The fully qualified name of the source item that contained the error.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -248,8 +248,8 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the starting column number for the source text that caused the error, if available.</summary>
<value>The starting column number for the source text that caused the error, if available.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down