Skip to content

Commit a663b91

Browse files
rocketsofthsvmairaw
rocketsofthsv
and
mairaw
committed
added summaries to missing items in 7 files, 45 items (#3551)
* added summaries to missing items in 7 files * Apply suggestions from code review Co-Authored-By: Maira Wenzel <[email protected]>
1 parent 6d40805 commit a663b91

File tree

7 files changed

+100
-85
lines changed

7 files changed

+100
-85
lines changed

‎xml/Microsoft.Vsa/BaseVsaEngine.xml

Lines changed: 49 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
</Attribute>
3131
</Attributes>
3232
<Docs>
33-
<summary>To be added.</summary>
33+
<summary>Defines the base script engine class.</summary>
3434
<remarks>To be added.</remarks>
3535
</Docs>
3636
<Members>
@@ -166,7 +166,7 @@
166166
</ReturnValue>
167167
<Parameters />
168168
<Docs>
169-
<summary>To be added.</summary>
169+
<summary>Closes the engine.</summary>
170170
<remarks>To be added.</remarks>
171171
</Docs>
172172
</Member>
@@ -191,8 +191,9 @@
191191
</ReturnValue>
192192
<Parameters />
193193
<Docs>
194-
<summary>To be added.</summary>
195-
<returns>To be added.</returns>
194+
<summary>Causes the engine to compile the existing source state.</summary>
195+
<returns>
196+
<see langword="true" /> on successful compilation; otherwise, <see langword="false" />.</returns>
196197
<remarks>To be added.</remarks>
197198
</Docs>
198199
</Member>
@@ -235,7 +236,7 @@
235236
</ReturnValue>
236237
<Parameters />
237238
<Docs>
238-
<summary>To be added.</summary>
239+
<summary>Closes the engine.</summary>
239240
<remarks>To be added.</remarks>
240241
</Docs>
241242
</Member>
@@ -257,8 +258,9 @@
257258
</ReturnValue>
258259
<Parameters />
259260
<Docs>
260-
<summary>To be added.</summary>
261-
<returns>To be added.</returns>
261+
<summary>Causes the script engine to compile the existing source state.</summary>
262+
<returns>
263+
<see langword="true" /> on successful compilation; otherwise, <see langword="false" />.</returns>
262264
<remarks>To be added.</remarks>
263265
</Docs>
264266
</Member>
@@ -282,8 +284,8 @@
282284
<Parameter Name="site" Type="Microsoft.Vsa.IVsaPersistSite" />
283285
</Parameters>
284286
<Docs>
285-
<param name="site">To be added.</param>
286-
<summary>To be added.</summary>
287+
<param name="site">The site from which the specified source items are loaded.</param>
288+
<summary>Directs the engine to load source items.</summary>
287289
<remarks>To be added.</remarks>
288290
</Docs>
289291
</Member>
@@ -308,9 +310,9 @@
308310
<Parameter Name="debugInfo" Type="System.Byte[]" RefType="out" />
309311
</Parameters>
310312
<Docs>
311-
<param name="pe">To be added.</param>
312-
<param name="debugInfo">To be added.</param>
313-
<summary>To be added.</summary>
313+
<param name="pe">The compiled state of the engine.</param>
314+
<param name="debugInfo">The debugging information contained in the .PDB file.</param>
315+
<summary>Saves the compiled state of the script engine; optionally, it also saves debugging information.</summary>
314316
<remarks>To be added.</remarks>
315317
</Docs>
316318
</Member>
@@ -334,8 +336,8 @@
334336
<Parameter Name="site" Type="Microsoft.Vsa.IVsaPersistSite" />
335337
</Parameters>
336338
<Docs>
337-
<param name="site">To be added.</param>
338-
<summary>To be added.</summary>
339+
<param name="site">The site to which source state is saved.</param>
340+
<summary>Directs the script engine to persist its source state to the specified object.</summary>
339341
<remarks>To be added.</remarks>
340342
</Docs>
341343
</Member>
@@ -422,9 +424,9 @@
422424
<Parameter Name="vsaErrorNumber" Type="Microsoft.Vsa.VsaError" />
423425
</Parameters>
424426
<Docs>
425-
<param name="vsaErrorNumber">To be added.</param>
426-
<summary>To be added.</summary>
427-
<returns>To be added.</returns>
427+
<param name="vsaErrorNumber">The error number to be returned.</param>
428+
<summary>Returns an error.</summary>
429+
<returns>An exception with the specified error number.</returns>
428430
<remarks>To be added.</remarks>
429431
</Docs>
430432
</Member>
@@ -582,9 +584,9 @@
582584
<Parameter Name="name" Type="System.String" />
583585
</Parameters>
584586
<Docs>
585-
<param name="name">To be added.</param>
586-
<summary>To be added.</summary>
587-
<returns>To be added.</returns>
587+
<param name="name">The name of the option to get.</param>
588+
<summary>Gets implementation-specific options for the engine.</summary>
589+
<returns>The value of the option..</returns>
588590
<remarks>To be added.</remarks>
589591
</Docs>
590592
</Member>
@@ -611,9 +613,9 @@
611613
<Parameter Name="name" Type="System.String" />
612614
</Parameters>
613615
<Docs>
614-
<param name="name">To be added.</param>
615-
<summary>To be added.</summary>
616-
<returns>To be added.</returns>
616+
<param name="name">The name of the option to get.</param>
617+
<summary>Gets implementation-specific options for the engine.</summary>
618+
<returns>The value of the option.</returns>
617619
<remarks>To be added.</remarks>
618620
</Docs>
619621
</Member>
@@ -659,7 +661,7 @@
659661
</ReturnValue>
660662
<Parameters />
661663
<Docs>
662-
<summary>To be added.</summary>
664+
<summary>Provides a notification that the initialization phase is complete.</summary>
663665
<remarks>To be added.</remarks>
664666
</Docs>
665667
</Member>
@@ -884,9 +886,10 @@
884886
<Parameter Name="ident" Type="System.String" />
885887
</Parameters>
886888
<Docs>
887-
<param name="ident">To be added.</param>
888-
<summary>To be added.</summary>
889-
<returns>To be added.</returns>
889+
<param name="ident">A string value provided as identifier.</param>
890+
<summary>Checks whether the supplied identifier is valid for the engine.</summary>
891+
<returns>
892+
<see langword="true" /> if the identifier is valid; otherwise, <see langword="false" />.</returns>
890893
<remarks>To be added.</remarks>
891894
</Docs>
892895
</Member>
@@ -910,9 +913,10 @@
910913
<Parameter Name="name" Type="System.String" />
911914
</Parameters>
912915
<Docs>
913-
<param name="name">To be added.</param>
914-
<summary>To be added.</summary>
915-
<returns>To be added.</returns>
916+
<param name="name">A string value provided as identifier.</param>
917+
<summary>Checks whether the supplied namespace is valid for the engine.</summary>
918+
<returns>
919+
<see langword="true" /> if the namespace is valid; otherwise, <see langword="false" />.</returns>
916920
<remarks>To be added.</remarks>
917921
</Docs>
918922
</Member>
@@ -1009,8 +1013,8 @@
10091013
</ReturnValue>
10101014
<Parameters />
10111015
<Docs>
1012-
<summary>To be added.</summary>
1013-
<returns>To be added.</returns>
1016+
<summary>Loads the compiled state.</summary>
1017+
<returns>The compiled state.</returns>
10141018
<remarks>To be added.</remarks>
10151019
</Docs>
10161020
</Member>
@@ -1058,8 +1062,8 @@
10581062
<Parameter Name="site" Type="Microsoft.Vsa.IVsaPersistSite" />
10591063
</Parameters>
10601064
<Docs>
1061-
<param name="site">To be added.</param>
1062-
<summary>To be added.</summary>
1065+
<param name="site">The site from which the specified source items are loaded.</param>
1066+
<summary>Directs the engine to load source items.</summary>
10631067
<remarks>To be added.</remarks>
10641068
</Docs>
10651069
</Member>
@@ -1129,8 +1133,8 @@
11291133
<Parameter Name="flags" Type="Microsoft.Vsa.BaseVsaEngine+Pre" />
11301134
</Parameters>
11311135
<Docs>
1132-
<param name="flags">To be added.</param>
1133-
<summary>To be added.</summary>
1136+
<param name="flags">The flags to set.</param>
1137+
<summary>Sets the precondition flags.</summary>
11341138
<remarks>To be added.</remarks>
11351139
</Docs>
11361140
</Member>
@@ -1155,7 +1159,7 @@
11551159
</ReturnValue>
11561160
<Parameters />
11571161
<Docs>
1158-
<summary>To be added.</summary>
1162+
<summary>Removes the engine from the running state and disconnects automatically bound event handlers.</summary>
11591163
<remarks>To be added.</remarks>
11601164
</Docs>
11611165
</Member>
@@ -1177,7 +1181,7 @@
11771181
</ReturnValue>
11781182
<Parameters />
11791183
<Docs>
1180-
<summary>To be added.</summary>
1184+
<summary>Resets the compiled state.</summary>
11811185
<remarks>To be added.</remarks>
11821186
</Docs>
11831187
</Member>
@@ -1202,7 +1206,7 @@
12021206
</ReturnValue>
12031207
<Parameters />
12041208
<Docs>
1205-
<summary>To be added.</summary>
1209+
<summary>Invalidates the cached assembly for the engine, as specified by its root moniker.</summary>
12061210
<remarks>To be added.</remarks>
12071211
</Docs>
12081212
</Member>
@@ -1402,9 +1406,9 @@
14021406
<Parameter Name="value" Type="System.Object" />
14031407
</Parameters>
14041408
<Docs>
1405-
<param name="name">To be added.</param>
1406-
<param name="value">To be added.</param>
1407-
<summary>To be added.</summary>
1409+
<param name="name">The name of the option to set.</param>
1410+
<param name="value">The value for the option being set.</param>
1411+
<summary>Sets implementation-specific options for the engine.</summary>
14081412
<remarks>To be added.</remarks>
14091413
</Docs>
14101414
</Member>
@@ -1432,9 +1436,9 @@
14321436
<Parameter Name="value" Type="System.Object" />
14331437
</Parameters>
14341438
<Docs>
1435-
<param name="name">To be added.</param>
1436-
<param name="value">To be added.</param>
1437-
<summary>To be added.</summary>
1439+
<param name="name">The name of the option to set.</param>
1440+
<param name="value">The name of the option to set.</param>
1441+
<summary>Sets implementation-specific options for the engine.</summary>
14381442
<remarks>To be added.</remarks>
14391443
</Docs>
14401444
</Member>

‎xml/Microsoft.Vsa/BaseVsaSite.xml

Lines changed: 18 additions & 17 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>Enables communication between the host and the script engine.</summary>
2828
<remarks>To be added.</remarks>
2929
</Docs>
3030
<Members>
@@ -114,9 +114,9 @@
114114
<Parameter Name="debugInfo" Type="System.Byte[]" RefType="out" />
115115
</Parameters>
116116
<Docs>
117-
<param name="pe">To be added.</param>
118-
<param name="debugInfo">To be added.</param>
119-
<summary>To be added.</summary>
117+
<param name="pe">An assembly to be set.</param>
118+
<param name="debugInfo">Debug info object to be set.</param>
119+
<summary>Sets an assembly and debug info for this site.</summary>
120120
<remarks>To be added.</remarks>
121121
</Docs>
122122
</Member>
@@ -144,10 +144,10 @@
144144
<Parameter Name="eventSourceName" Type="System.String" />
145145
</Parameters>
146146
<Docs>
147-
<param name="itemName">To be added.</param>
148-
<param name="eventSourceName">To be added.</param>
149-
<summary>To be added.</summary>
150-
<returns>To be added.</returns>
147+
<param name="itemName">The item name.</param>
148+
<param name="eventSourceName">The event source name.</param>
149+
<summary>Gets a reference to an event source previously added to a script engine using the AddEventSource(String, String) method.</summary>
150+
<returns>The event source to the engine.</returns>
151151
<remarks>To be added.</remarks>
152152
</Docs>
153153
</Member>
@@ -174,9 +174,9 @@
174174
<Parameter Name="name" Type="System.String" />
175175
</Parameters>
176176
<Docs>
177-
<param name="name">To be added.</param>
178-
<summary>To be added.</summary>
179-
<returns>To be added.</returns>
177+
<param name="name">The item name.</param>
178+
<summary>Gets a reference to a global item, such as the host-provided application object.</summary>
179+
<returns>A reference to the global object.</returns>
180180
<remarks>To be added.</remarks>
181181
</Docs>
182182
</Member>
@@ -204,9 +204,9 @@
204204
<Parameter Name="optional" Type="System.Object" />
205205
</Parameters>
206206
<Docs>
207-
<param name="notify">To be added.</param>
208-
<param name="optional">To be added.</param>
209-
<summary>To be added.</summary>
207+
<param name="notify">Notifies the host about events generated by the script engine.</param>
208+
<param name="optional">Notifies the host about events generated by the engine.</param>
209+
<summary>Notifies the host about events generated by the script engine.</summary>
210210
<remarks>To be added.</remarks>
211211
</Docs>
212212
</Member>
@@ -233,9 +233,10 @@
233233
<Parameter Name="error" Type="Microsoft.Vsa.IVsaError" />
234234
</Parameters>
235235
<Docs>
236-
<param name="error">To be added.</param>
237-
<summary>To be added.</summary>
238-
<returns>To be added.</returns>
236+
<param name="error">The IVsaError object representing the offending error.</param>
237+
<summary>Notifies the host about how to respond to compiler errors encountered by the script engine.</summary>
238+
<returns>
239+
<see langword="true" /> if the compiler is directed to continue reporting further errors to the IJSVsaSite object; <see langword="false" /> if the compiler is directed to stop reporting further errors to the IVsaSite object.</returns>
239240
<remarks>To be added.</remarks>
240241
</Docs>
241242
</Member>

‎xml/Microsoft.Vsa/BaseVsaStartup.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>Used to start and reset base VSA engine.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -62,8 +62,8 @@
6262
<Parameter Name="site" Type="Microsoft.Vsa.IVsaSite" />
6363
</Parameters>
6464
<Docs>
65-
<param name="site">To be added.</param>
66-
<summary>To be added.</summary>
65+
<param name="site">A VSA site for this engine.</param>
66+
<summary>Sets a VSA site for this engine.</summary>
6767
<remarks>To be added.</remarks>
6868
</Docs>
6969
</Member>
@@ -85,7 +85,7 @@
8585
</ReturnValue>
8686
<Parameters />
8787
<Docs>
88-
<summary>To be added.</summary>
88+
<summary>Performs operations at engine shut down.</summary>
8989
<remarks>To be added.</remarks>
9090
</Docs>
9191
</Member>
@@ -128,7 +128,7 @@
128128
</ReturnValue>
129129
<Parameters />
130130
<Docs>
131-
<summary>To be added.</summary>
131+
<summary>Performs operations at engine startup.</summary>
132132
<remarks>To be added.</remarks>
133133
</Docs>
134134
</Member>

‎xml/Microsoft.Vsa/IVsaDTEngine.xml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,11 @@
4747
<Parameter Name="isAttach" Type="System.Boolean" />
4848
</Parameters>
4949
<Docs>
50-
<param name="isAttach">To be added.</param>
51-
<summary>This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
50+
<param name="isAttach">
51+
<see langword="true" /> to indicate the debugger is attachable; otherwise, <see langword="false" />.</param>
52+
<summary>Attaches the debugger.</summary>
5253
<remarks>To be added.</remarks>
54+
<forInternalUseOnly />
5355
</Docs>
5456
</Member>
5557
<Member MemberName="GetIDE">
@@ -70,9 +72,10 @@
7072
</ReturnValue>
7173
<Parameters />
7274
<Docs>
73-
<summary>This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
74-
<returns>To be added.</returns>
75+
<summary>Returns the IDE.</summary>
76+
<returns>The IDE.</returns>
7577
<remarks>To be added.</remarks>
78+
<forInternalUseOnly />
7679
</Docs>
7780
</Member>
7881
<Member MemberName="InitCompleted">

0 commit comments

Comments
 (0)