Skip to content

Commit a5ca6ee

Browse files
steveadamairaw
authored andcommitted
Missing API docs part 4 - SA (#3654)
* missing refs * XML error * Apply suggestions from code review Co-Authored-By: Maira Wenzel <[email protected]> * source error * link error
1 parent e615d17 commit a5ca6ee

File tree

5 files changed

+58
-46
lines changed

5 files changed

+58
-46
lines changed

xml/Microsoft.CLRAdmin/IPropertySheetCallback.xml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,10 @@
4242
<Parameter Name="hPage" Type="System.IntPtr" />
4343
</Parameters>
4444
<Docs>
45-
<param name="hPage">To be added.</param>
46-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
45+
<param name="hPage">The handle to a property sheet page to add to a property sheet.</param>
46+
<summary>Adds a page to a property sheet.</summary>
4747
<remarks>To be added.</remarks>
48+
<forInternalUseOnly />
4849
</Docs>
4950
</Member>
5051
<Member MemberName="RemovePage">
@@ -66,9 +67,10 @@
6667
<Parameter Name="hPage" Type="System.IntPtr" />
6768
</Parameters>
6869
<Docs>
69-
<param name="hPage">To be added.</param>
70-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
70+
<param name="hPage">The handle to a property sheet page to remove from a property sheet.</param>
71+
<summary>Removes a page from a property sheet.</summary>
7172
<remarks>To be added.</remarks>
73+
<forInternalUseOnly />
7274
</Docs>
7375
</Member>
7476
</Members>

xml/Microsoft.CLRAdmin/ISnapinAbout.xml

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,10 @@
4242
<Parameter Name="pName" Type="System.IntPtr" RefType="out" />
4343
</Parameters>
4444
<Docs>
45-
<param name="pName">To be added.</param>
46-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
45+
<param name="pName">When this method returns, contains the provider name of the snap-in. This parameter is passed uninitialized.</param>
46+
<summary>Obtains the provider name of the snap-in.</summary>
4747
<remarks>To be added.</remarks>
48+
<forInternalUseOnly />
4849
</Docs>
4950
</Member>
5051
<Member MemberName="GetSnapinDescription">
@@ -66,9 +67,10 @@
6667
<Parameter Name="lpDescription" Type="System.IntPtr" RefType="out" />
6768
</Parameters>
6869
<Docs>
69-
<param name="lpDescription">To be added.</param>
70-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
70+
<param name="lpDescription">When this method returns, contains the text for the description box on an About property page. This parameter is passed uninitialized.</param>
71+
<summary>Allows the console to get the text for the description box on the About property page for the snap-in.</summary>
7172
<remarks>To be added.</remarks>
73+
<forInternalUseOnly />
7274
</Docs>
7375
</Member>
7476
<Member MemberName="GetSnapinImage">
@@ -90,9 +92,10 @@
9092
<Parameter Name="hAppIcon" Type="System.IntPtr" RefType="out" />
9193
</Parameters>
9294
<Docs>
93-
<param name="hAppIcon">To be added.</param>
94-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
95+
<param name="hAppIcon">When this method returns, contains the handle to the main icon of the snap-in used by the About property page. This parameter is passed uninitialized.</param>
96+
<summary>Allows the console to get the main icon that is used in the About property page for a snap-in.</summary>
9597
<remarks>To be added.</remarks>
98+
<forInternalUseOnly />
9699
</Docs>
97100
</Member>
98101
<Member MemberName="GetSnapinVersion">
@@ -114,9 +117,10 @@
114117
<Parameter Name="lpVersion" Type="System.IntPtr" RefType="out" />
115118
</Parameters>
116119
<Docs>
117-
<param name="lpVersion">To be added.</param>
118-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
120+
<param name="lpVersion">When this method returns, contains text specifying the version number for the snap-in. This parameter is passed uninitialized.</param>
121+
<summary>Allows the console to get the version number for the snap-in.</summary>
119122
<remarks>To be added.</remarks>
123+
<forInternalUseOnly />
120124
</Docs>
121125
</Member>
122126
<Member MemberName="GetStaticFolderImage">
@@ -141,12 +145,13 @@
141145
<Parameter Name="cMask" Type="System.Int32" RefType="out" />
142146
</Parameters>
143147
<Docs>
144-
<param name="hSmallImage">To be added.</param>
145-
<param name="hSmallImageOpen">To be added.</param>
146-
<param name="hLargeImage">To be added.</param>
147-
<param name="cMask">To be added.</param>
148-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
148+
<param name="hSmallImage">When this method returns, contains the handle to a small icon (16 x 16 pixels) in either the scope or results view pane.</param>
149+
<param name="hSmallImageOpen">When this method returns, contains the handle to a small open folder icon (16 x 16 pixels).</param>
150+
<param name="hLargeImage">When this method returns, contains the handle to a large icon (32 x 32 pixels).</param>
151+
<param name="cMask">When this method returns, contains a structure that specifies the color used to generate a mask.</param>
152+
<summary>Allows the console to get the static folder images for the scope and results panes.</summary>
149153
<remarks>To be added.</remarks>
154+
<forInternalUseOnly />
150155
</Docs>
151156
</Member>
152157
</Members>

xml/Microsoft.CLRAdmin/MMC_CONTROL_TYPE.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
</ReturnValue>
3535
<MemberValue>2</MemberValue>
3636
<Docs>
37-
<summary>To be added.</summary>
37+
<summary>A combo box control.</summary>
3838
</Docs>
3939
</Member>
4040
<Member MemberName="MENUBUTTON">
@@ -54,7 +54,7 @@
5454
</ReturnValue>
5555
<MemberValue>1</MemberValue>
5656
<Docs>
57-
<summary>To be added.</summary>
57+
<summary>A drop-down menu control.</summary>
5858
</Docs>
5959
</Member>
6060
<Member MemberName="TOOLBAR">
@@ -74,7 +74,7 @@
7474
</ReturnValue>
7575
<MemberValue>0</MemberValue>
7676
<Docs>
77-
<summary>To be added.</summary>
77+
<summary>A toolbar control.</summary>
7878
</Docs>
7979
</Member>
8080
</Members>

xml/Microsoft.CLRAdmin/PropSheetPageProc.xml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,12 @@
2121
<ReturnType>System.UInt32</ReturnType>
2222
</ReturnValue>
2323
<Docs>
24-
<param name="hwnd">To be added.</param>
25-
<param name="uMsg">To be added.</param>
26-
<param name="lParam">To be added.</param>
27-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
28-
<returns>To be added.</returns>
24+
<param name="hwnd">Reserved; must be null (Nothing in Visual Basic).</param>
25+
<param name="uMsg">An action flag specifying that a page or a dialog box for a page is being created or a page is being destroyed.</param>
26+
<param name="lParam">A pointer to a structure defining the page being created or destroyed.</param>
27+
<summary>Specifies a callback function that a property sheet calls when a page is created and when the page is about to be destroyed.</summary>
28+
<returns>The value of uMsg.</returns>
2929
<remarks>To be added.</remarks>
30+
<forInternalUseOnly />
3031
</Docs>
3132
</Type>

xml/Microsoft.JScript.Vsa/VsaEngine.xml

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,9 @@
117117
<Parameter Name="domain" Type="System.AppDomain" 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" />
118118
</Parameters>
119119
<Docs>
120-
<param name="domain">To be added.</param>
121-
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
122-
<returns>To be added.</returns>
120+
<param name="domain">The application domain in which to create the new engine.</param>
121+
<summary>Creates a new identical engine that runs in a new application domain, with the same compiled state and named items. </summary>
122+
<returns>The new engine.</returns>
123123
<remarks>To be added.</remarks>
124124
<forInternalUseOnly />
125125
</Docs>
@@ -146,8 +146,9 @@
146146
</ReturnValue>
147147
<Parameters />
148148
<Docs>
149-
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
150-
<returns>To be added.</returns>
149+
<summary>Triggers compilation of all the state currently in the engine. All references, code items, host items, and resources are run through the compiler.</summary>
150+
<returns>
151+
<see langword="true" /> if the compilation was successful; otherwise, <see langword="false" />.</returns>
151152
<remarks>To be added.</remarks>
152153
<forInternalUseOnly />
153154
</Docs>
@@ -551,8 +552,8 @@
551552
</ReturnValue>
552553
<Parameters />
553554
<Docs>
554-
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
555-
<returns>To be added.</returns>
555+
<summary>Gets the compiled assembly that is produced by the compilation step.</summary>
556+
<returns>The compiled assembly.</returns>
556557
<remarks>To be added.</remarks>
557558
<forInternalUseOnly />
558559
</Docs>
@@ -606,8 +607,8 @@
606607
</ReturnValue>
607608
<Parameters />
608609
<Docs>
609-
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
610-
<returns>To be added.</returns>
610+
<summary>Gets the global scope object.</summary>
611+
<returns>The global scope object.</returns>
611612
<remarks>To be added.</remarks>
612613
<forInternalUseOnly />
613614
</Docs>
@@ -736,8 +737,8 @@
736737
</ReturnValue>
737738
<Parameters />
738739
<Docs>
739-
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
740-
<returns>To be added.</returns>
740+
<summary>Gets the code module from the compiled assembly.</summary>
741+
<returns>The code module from the compiled assembly.</returns>
741742
<remarks>To be added.</remarks>
742743
<forInternalUseOnly />
743744
</Docs>
@@ -840,10 +841,11 @@
840841
<Parameter Name="site" Type="Microsoft.JScript.Vsa.IJSVsaSite" Index="1" 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" />
841842
</Parameters>
842843
<Docs>
843-
<param name="rootMoniker">To be added.</param>
844-
<param name="site">To be added.</param>
845-
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
844+
<param name="rootMoniker">The root moniker of the script engine.</param>
845+
<param name="site">The host-implemented <see cref="T:Microsoft.JScript.Vsa.IJSVsaSite" /> object that is used by the script engine to communicate with the host.</param>
846+
<summary>Initializes the <see cref="T:Microsoft.JScript.Vsa.VsaEngine" />.</summary>
846847
<remarks>To be added.</remarks>
848+
<forInternalUseOnly />
847849
</Docs>
848850
</Member>
849851
<Member MemberName="InitVsaEngine">
@@ -870,10 +872,11 @@
870872
<Parameter Name="site" Type="Microsoft.Vsa.IVsaSite" Index="1" FrameworkAlternate="netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5" />
871873
</Parameters>
872874
<Docs>
873-
<param name="rootMoniker">To be added.</param>
874-
<param name="site">To be added.</param>
875-
<summary>This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
875+
<param name="rootMoniker">The root moniker of the script engine.</param>
876+
<param name="site">The host-implemented <see cref="T:Microsoft.Vsa.IVsaSite" /> object that is used by the script engine to communicate with the host.</param>
877+
<summary>Initializes the <see cref="T:Microsoft.JScript.Vsa.VsaEngine" />.</summary>
876878
<remarks>To be added.</remarks>
879+
<forInternalUseOnly />
877880
</Docs>
878881
</Member>
879882
<Member MemberName="Interrupt">
@@ -1080,8 +1083,8 @@
10801083
<Parameter Name="name" Type="System.String" />
10811084
</Parameters>
10821085
<Docs>
1083-
<param name="name">To be added.</param>
1084-
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
1086+
<param name="name">The name of an added item that provides events.</param>
1087+
<summary>Specifies the name of an item that is marked as an event source, so that the <see cref="M:Microsoft.JScript.Vsa.VsaEngine.ConnectEvents" /> method can determine which events to connect.</summary>
10851088
<remarks>To be added.</remarks>
10861089
<forInternalUseOnly />
10871090
</Docs>
@@ -1182,9 +1185,10 @@
11821185
<Parameter Name="domain" Type="System.AppDomain" />
11831186
</Parameters>
11841187
<Docs>
1185-
<param name="domain">To be added.</param>
1186-
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
1188+
<param name="domain">The application domain in which to run the compiled code.</param>
1189+
<summary>Runs the compiled code in the specified application domain.</summary>
11871190
<remarks>To be added.</remarks>
1191+
<forInternalUseOnly />
11881192
</Docs>
11891193
</Member>
11901194
<Member MemberName="RunEmpty">

0 commit comments

Comments
 (0)