Skip to content

Commit 9782ff2

Browse files
steveadamairaw
andcommitted
Add missing API docs part 11 - SA (#3747)
* add missing items * add out description * small edits * fix broken link Co-authored-by: Maira Wenzel <[email protected]>
1 parent 67e93ec commit 9782ff2

File tree

3 files changed

+57
-42
lines changed

3 files changed

+57
-42
lines changed

xml/Microsoft.CLRAdmin/CData.xml

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -193,12 +193,18 @@
193193
<Parameter Name="lpIDataObject" Type="Microsoft.CLRAdmin.IDataObject" />
194194
</Parameters>
195195
<Docs>
196-
<param name="lpProvider">To be added.</param>
197-
<param name="handle">To be added.</param>
198-
<param name="lpIDataObject">To be added.</param>
199-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
200-
<returns>To be added.</returns>
196+
<param name="lpProvider">A pointer to the <see cref="T:Microsoft.CLRAdmin.IPropertySheetCallback" />.</param>
197+
<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>
198+
<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>
199+
<summary>Adds pages to a property sheet.</summary>
200+
<returns>| Return Value | Description |
201+
| --- | --- |
202+
| 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. |
203+
| S\_FALSE | The <see cref="M:Microsoft.CLRAdmin.CData.CreatePropertyPages(Microsoft.CLRAdmin.IPropertySheetCallback,System.IntPtr,Microsoft.CLRAdmin.IDataObject)" /> method added no property sheet pages. |
204+
| E\_UNEXPECTED | An unexpected error occurred. |
205+
| E\_INVALIDARG | One or more parameters are not valid. |</returns>
201206
<remarks>To be added.</remarks>
207+
<forInternalUseOnly />
202208
</Docs>
203209
</Member>
204210
<Member MemberName="Destroy">
@@ -278,14 +284,17 @@
278284
<Parameter Name="bStretch" Type="System.Int32" RefType="out" />
279285
</Parameters>
280286
<Docs>
281-
<param name="lpIDataObject">To be added.</param>
282-
<param name="lphWatermark">To be added.</param>
283-
<param name="lphHeader">To be added.</param>
284-
<param name="lphPalette">To be added.</param>
285-
<param name="bStretch">To be added.</param>
286-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
287-
<returns>To be added.</returns>
287+
<param name="lpIDataObject">The <see cref="T:Microsoft.CLRAdmin.IDataObject" /> on the object containing context information about the scope or result item.</param>
288+
<param name="lphWatermark">When this method returns, the handle to a bitmap that serves as the watermark for Wizard 97 pages.</param>
289+
<param name="lphHeader">When this method returns, the handle to a bitmap that serves as the header for Wizard 97 pages.</param>
290+
<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>
291+
<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>
292+
<summary>Retrieves the watermark and header bitmaps for wizard sheets that are implemented as Wizard 97-style wizards.</summary>
293+
<returns>| Return Value | Description |
294+
| --- | --- |
295+
| etch | <see langword="true" /> if the watermark and header bitmaps should be stretched rather than tiled; otherwise, <see langword="false" />. |</returns>
288296
<remarks>To be added.</remarks>
297+
<forInternalUseOnly />
289298
</Docs>
290299
</Member>
291300
<Member MemberName="Initialize">
@@ -402,10 +411,16 @@
402411
<Parameter Name="lpDataObject" Type="Microsoft.CLRAdmin.IDataObject" />
403412
</Parameters>
404413
<Docs>
405-
<param name="lpDataObject">To be added.</param>
406-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
407-
<returns>To be added.</returns>
414+
<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>
415+
<summary>Determines whether the object requires pages.</summary>
416+
<returns>| Return value | Description |
417+
| --- | --- |
418+
| S\_OK | Properties exist for this data object. |
419+
| E\_UNEXPECTED | An unexpected error occurred. |
420+
| E\_INVALID | The parameter is not valid. |
421+
| Any other error code | No pages are supplied for the data object. |</returns>
408422
<remarks>To be added.</remarks>
423+
<forInternalUseOnly />
409424
</Docs>
410425
</Member>
411426
</Members>

xml/Microsoft.JScript.Vsa/VsaEngine.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -632,9 +632,9 @@
632632
<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" />
633633
</Parameters>
634634
<Docs>
635-
<param name="itemName">To be added.</param>
636-
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
637-
<returns>To be added.</returns>
635+
<param name="itemName">The name of the item to get.</param>
636+
<summary>Gets the item from the scope that is designated by the specified name.</summary>
637+
<returns>The item with the specified name.</returns>
638638
<remarks>To be added.</remarks>
639639
<forInternalUseOnly />
640640
</Docs>
@@ -658,9 +658,9 @@
658658
<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" />
659659
</Parameters>
660660
<Docs>
661-
<param name="index">To be added.</param>
662-
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
663-
<returns>To be added.</returns>
661+
<param name="index">The index of the item to get.</param>
662+
<summary>Gets the item from the scope that is designated by the specified index value.</summary>
663+
<returns>The item at the specified index.</returns>
664664
<remarks>To be added.</remarks>
665665
<forInternalUseOnly />
666666
</Docs>
@@ -684,8 +684,8 @@
684684
</ReturnValue>
685685
<Parameters />
686686
<Docs>
687-
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
688-
<returns>To be added.</returns>
687+
<summary>Gets the number of items in the scope.</summary>
688+
<returns>The number of items in the scope.</returns>
689689
<remarks>To be added.</remarks>
690690
<forInternalUseOnly />
691691
</Docs>

xml/Microsoft.VisualBasic.Vsa/VsaCompilerError.xml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
</Attribute>
2525
</Attributes>
2626
<Docs>
27-
<summary>To be added.</summary>
27+
<summary>Represents a compiler error or warning.</summary>
2828
<remarks>To be added.</remarks>
2929
</Docs>
3030
<Members>
@@ -48,8 +48,8 @@
4848
<ReturnType>System.String</ReturnType>
4949
</ReturnValue>
5050
<Docs>
51-
<summary>To be added.</summary>
52-
<value>To be added.</value>
51+
<summary>Gets a brief description of the error.</summary>
52+
<value>A string description of the error.</value>
5353
<remarks>To be added.</remarks>
5454
</Docs>
5555
</Member>
@@ -73,8 +73,8 @@
7373
<ReturnType>System.Int32</ReturnType>
7474
</ReturnValue>
7575
<Docs>
76-
<summary>To be added.</summary>
77-
<value>To be added.</value>
76+
<summary>Gets the ending column number for the source text that caused the error, if available.</summary>
77+
<value>The ending column number for the source text that caused the error, if available.</value>
7878
<remarks>To be added.</remarks>
7979
</Docs>
8080
</Member>
@@ -98,8 +98,8 @@
9898
<ReturnType>System.Int32</ReturnType>
9999
</ReturnValue>
100100
<Docs>
101-
<summary>To be added.</summary>
102-
<value>To be added.</value>
101+
<summary>Gets the line number on which an error occurs.</summary>
102+
<value>The line number on which the error has occurred.</value>
103103
<remarks>To be added.</remarks>
104104
</Docs>
105105
</Member>
@@ -123,8 +123,8 @@
123123
<ReturnType>System.String</ReturnType>
124124
</ReturnValue>
125125
<Docs>
126-
<summary>To be added.</summary>
127-
<value>To be added.</value>
126+
<summary>Gets the text of the source code from the line that caused the error.</summary>
127+
<value>The source code from the line that caused the error.</value>
128128
<remarks>To be added.</remarks>
129129
</Docs>
130130
</Member>
@@ -148,8 +148,8 @@
148148
<ReturnType>System.Int32</ReturnType>
149149
</ReturnValue>
150150
<Docs>
151-
<summary>To be added.</summary>
152-
<value>To be added.</value>
151+
<summary>Gets a number that uniquely identifies the error.</summary>
152+
<value>The number that uniquely identifies the error.</value>
153153
<remarks>To be added.</remarks>
154154
</Docs>
155155
</Member>
@@ -173,8 +173,8 @@
173173
<ReturnType>System.Int32</ReturnType>
174174
</ReturnValue>
175175
<Docs>
176-
<summary>To be added.</summary>
177-
<value>To be added.</value>
176+
<summary>Gets the severity of the error.</summary>
177+
<value>An integer (0-4) that represents the error severity.</value>
178178
<remarks>To be added.</remarks>
179179
</Docs>
180180
</Member>
@@ -198,8 +198,8 @@
198198
<ReturnType>Microsoft.Vsa.IVsaItem</ReturnType>
199199
</ReturnValue>
200200
<Docs>
201-
<summary>To be added.</summary>
202-
<value>To be added.</value>
201+
<summary>Gets a reference to the <see cref="T:Microsoft.Vsa.IVsaItem" /> object that generated the error.</summary>
202+
<value>A reference to the object that generated the error.</value>
203203
<remarks>To be added.</remarks>
204204
</Docs>
205205
</Member>
@@ -223,8 +223,8 @@
223223
<ReturnType>System.String</ReturnType>
224224
</ReturnValue>
225225
<Docs>
226-
<summary>To be added.</summary>
227-
<value>To be added.</value>
226+
<summary>Gets the fully qualified name of the source item that contained the error.</summary>
227+
<value>The fully qualified name of the source item that contained the error.</value>
228228
<remarks>To be added.</remarks>
229229
</Docs>
230230
</Member>
@@ -248,8 +248,8 @@
248248
<ReturnType>System.Int32</ReturnType>
249249
</ReturnValue>
250250
<Docs>
251-
<summary>To be added.</summary>
252-
<value>To be added.</value>
251+
<summary>Gets the starting column number for the source text that caused the error, if available.</summary>
252+
<value>The starting column number for the source text that caused the error, if available.</value>
253253
<remarks>To be added.</remarks>
254254
</Docs>
255255
</Member>

0 commit comments

Comments
 (0)