Skip to content

Commit 18a8f93

Browse files
steveadamairaw
steveada
and
mairaw
committed
Missing API docs part 2 - SA (#3567)
* add missing API refs * Apply suggestions from code review Suggestions from SME review Co-Authored-By: Maira Wenzel <[email protected]> * Follow-up changes suggested by SME review * Apply suggestions from code review Co-Authored-By: Maira Wenzel <[email protected]>
1 parent 611f7a1 commit 18a8f93

File tree

9 files changed

+82
-74
lines changed

9 files changed

+82
-74
lines changed

‎xml/Microsoft.VisualBasic.Vsa/VsaCodeItem.xml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
</Attribute>
2828
</Attributes>
2929
<Docs>
30-
<summary>To be added.</summary>
30+
<summary>Represents a code item to be compiled by the script engine.</summary>
3131
<remarks>To be added.</remarks>
3232
</Docs>
3333
<Members>
@@ -77,9 +77,9 @@
7777
<Parameter Name="EventSourceType" Type="System.String" />
7878
</Parameters>
7979
<Docs>
80-
<param name="EventSourceName">To be added.</param>
81-
<param name="EventSourceType">To be added.</param>
82-
<summary>To be added.</summary>
80+
<param name="EventSourceName">A programmatic name of the event source.</param>
81+
<param name="EventSourceType">The type name of the event source.</param>
82+
<summary>Adds an event source to the code item.</summary>
8383
<remarks>To be added.</remarks>
8484
</Docs>
8585
</Member>
@@ -106,8 +106,8 @@
106106
<Parameter Name="Text" Type="System.String" />
107107
</Parameters>
108108
<Docs>
109-
<param name="Text">To be added.</param>
110-
<summary>To be added.</summary>
109+
<param name="Text">The text to be appended to the code item.</param>
110+
<summary>Appends the specified text to the end of the code item.</summary>
111111
<remarks>To be added.</remarks>
112112
</Docs>
113113
</Member>
@@ -131,8 +131,8 @@
131131
<ReturnType>System.CodeDom.CodeObject</ReturnType>
132132
</ReturnValue>
133133
<Docs>
134-
<summary>To be added.</summary>
135-
<value>To be added.</value>
134+
<summary>Gets the code document object model (CodeDOM) represented in the code item.</summary>
135+
<value>The CodeDOM for the code item.</value>
136136
<remarks>To be added.</remarks>
137137
</Docs>
138138
</Member>
@@ -159,8 +159,8 @@
159159
<Parameter Name="EventSourceName" Type="System.String" />
160160
</Parameters>
161161
<Docs>
162-
<param name="EventSourceName">To be added.</param>
163-
<summary>To be added.</summary>
162+
<param name="EventSourceName">The programmatic name of the event source to be removed.</param>
163+
<summary>Removes the specified event source from the code item.</summary>
164164
<remarks>To be added.</remarks>
165165
</Docs>
166166
</Member>
@@ -184,8 +184,8 @@
184184
<ReturnType>System.String</ReturnType>
185185
</ReturnValue>
186186
<Docs>
187-
<summary>To be added.</summary>
188-
<value>To be added.</value>
187+
<summary>Gets or sets the text of a specified code item, including auto-generated code, if any.</summary>
188+
<value>The text of a specified code item.</value>
189189
<remarks>To be added.</remarks>
190190
</Docs>
191191
</Member>

‎xml/Microsoft.VisualBasic.Vsa/VsaEngine.xml

Lines changed: 57 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@
108108
<ReturnType>System.Reflection.Assembly</ReturnType>
109109
</ReturnValue>
110110
<Docs>
111-
<summary>To be added.</summary>
112-
<value>To be added.</value>
111+
<summary>Gets a reference to the running assembly generated by the <see cref="M:Microsoft.VisualBasic.Vsa.VsaEngine.Run" /> method.</summary>
112+
<value>A reference to the running assembly generated by the <see cref="M:Microsoft.VisualBasic.Vsa.VsaEngine.Run" /> method</value>
113113
<remarks>To be added.</remarks>
114114
</Docs>
115115
</Member>
@@ -156,7 +156,7 @@
156156
</ReturnValue>
157157
<Parameters />
158158
<Docs>
159-
<summary>To be added.</summary>
159+
<summary>Closes the script engine and releases all resources. If the script engine is currently running, the <see cref="M:Microsoft.VisualBasic.Vsa.VsaEngine.Reset" /> method is called first.</summary>
160160
<remarks>To be added.</remarks>
161161
</Docs>
162162
</Member>
@@ -181,8 +181,9 @@
181181
</ReturnValue>
182182
<Parameters />
183183
<Docs>
184-
<summary>To be added.</summary>
185-
<returns>To be added.</returns>
184+
<summary>Causes the script engine to compile the existing source state.</summary>
185+
<returns>
186+
<see langword="true" /> on successful compilation, indicating that the <see cref="M:Microsoft.VisualBasic.Vsa.VsaEngine" /> method can be called on the newly compiled assembly; <see langword="false" /> if the compilation failed.</returns>
186187
<remarks>To be added.</remarks>
187188
</Docs>
188189
</Member>
@@ -254,8 +255,8 @@
254255
<ReturnType>System.Security.Policy.Evidence</ReturnType>
255256
</ReturnValue>
256257
<Docs>
257-
<summary>To be added.</summary>
258-
<value>To be added.</value>
258+
<summary>Gets or sets the evidence for the purpose of validating the current object's identity.</summary>
259+
<value>The evidence to validate the current object's identity.</value>
259260
<remarks>To be added.</remarks>
260261
</Docs>
261262
</Member>
@@ -301,8 +302,9 @@
301302
<ReturnType>System.Boolean</ReturnType>
302303
</ReturnValue>
303304
<Docs>
304-
<summary>To be added.</summary>
305-
<value>To be added.</value>
305+
<summary>Gets or sets a value that indicates whether the script engine produces debug information when the Compile method is called.</summary>
306+
<value>
307+
<see langword="true" /> if the script engine produces debug information; otherwise, <see langword="false" />.</value>
306308
<remarks>To be added.</remarks>
307309
</Docs>
308310
</Member>
@@ -355,9 +357,9 @@
355357
<Parameter Name="Name" Type="System.String" />
356358
</Parameters>
357359
<Docs>
358-
<param name="Name">To be added.</param>
359-
<summary>To be added.</summary>
360-
<returns>To be added.</returns>
360+
<param name="Name">The name of the option to get.</param>
361+
<summary>Gets implementation-specific options for the engine.</summary>
362+
<returns>The value of the option.</returns>
361363
<remarks>To be added.</remarks>
362364
</Docs>
363365
</Member>
@@ -382,7 +384,7 @@
382384
</ReturnValue>
383385
<Parameters />
384386
<Docs>
385-
<summary>To be added.</summary>
387+
<summary>Provides a notification that the initialization phase is complete.</summary>
386388
<remarks>To be added.</remarks>
387389
</Docs>
388390
</Member>
@@ -406,8 +408,9 @@
406408
<ReturnType>System.Boolean</ReturnType>
407409
</ReturnValue>
408410
<Docs>
409-
<summary>To be added.</summary>
410-
<value>To be added.</value>
411+
<summary>Gets a value that indicates whether the script engine is set to produce debug information when the <see cref="M:Microsoft.VisualBasic.Vsa.VsaEngine.Compile" /> method is called.</summary>
412+
<value>
413+
<see langword="true" /> if the script engine is set to produce debug information when the <see cref="M:Microsoft.VisualBasic.Vsa.VsaEngine.Compile" /> method is called; otherwise, <see langword="false" />.</value>
411414
<remarks>To be added.</remarks>
412415
</Docs>
413416
</Member>
@@ -431,8 +434,9 @@
431434
<ReturnType>System.Boolean</ReturnType>
432435
</ReturnValue>
433436
<Docs>
434-
<summary>To be added.</summary>
435-
<value>To be added.</value>
437+
<summary>Gets a value that indicates whether the script engine's source state has changed since the last save operation, or since the script engine was originally loaded.</summary>
438+
<value>
439+
<see langword="true" /> if the script engine is marked as modified (that is, "dirty"); otherwise, <see langword="false" />. The default value is <see langword="false" />.</value>
436440
<remarks>To be added.</remarks>
437441
</Docs>
438442
</Member>
@@ -456,8 +460,9 @@
456460
<ReturnType>System.Boolean</ReturnType>
457461
</ReturnValue>
458462
<Docs>
459-
<summary>To be added.</summary>
460-
<value>To be added.</value>
463+
<summary>Gets a value that indicates whether the script engine is currently in run mode.</summary>
464+
<value>
465+
<see langword="true" /> if the script engine is running; otherwise, <see langword="false" />. The default value for this property is <see langword="false" />.</value>
461466
<remarks>To be added.</remarks>
462467
</Docs>
463468
</Member>
@@ -484,9 +489,10 @@
484489
<Parameter Name="identifier" Type="System.String" />
485490
</Parameters>
486491
<Docs>
487-
<param name="identifier">To be added.</param>
488-
<summary>To be added.</summary>
489-
<returns>To be added.</returns>
492+
<param name="identifier">A string value provided as identifier.</param>
493+
<summary>Checks whether the supplied identifier is valid for the script engine.</summary>
494+
<returns>
495+
<see langword="true" /> if the identifier is valid; otherwise, <see langword="false" />.</returns>
490496
<remarks>To be added.</remarks>
491497
</Docs>
492498
</Member>
@@ -510,8 +516,8 @@
510516
<ReturnType>Microsoft.Vsa.IVsaItems</ReturnType>
511517
</ReturnValue>
512518
<Docs>
513-
<summary>To be added.</summary>
514-
<value>To be added.</value>
519+
<summary>Gets the <see cref="T:Microsoft.Vsa.IVsaItems" /> collection of <see cref="T:Microsoft.Vsa.IVsaItem" /> objects, which represent all items added to the script engine using the CreateItem method, including code items, reference items, and global items.</summary>
520+
<value>A collection of all items added to the script engine using the CreateItem method, including code items, reference items, and global items.</value>
515521
<remarks>To be added.</remarks>
516522
</Docs>
517523
</Member>
@@ -535,8 +541,8 @@
535541
<ReturnType>System.String</ReturnType>
536542
</ReturnValue>
537543
<Docs>
538-
<summary>To be added.</summary>
539-
<value>To be added.</value>
544+
<summary>Gets the non-localized name of the programming language supported by the script engine.</summary>
545+
<value>The English-language name of the programming language supported by the script engine.</value>
540546
<remarks>To be added.</remarks>
541547
</Docs>
542548
</Member>
@@ -560,8 +566,8 @@
560566
<ReturnType>System.Int32</ReturnType>
561567
</ReturnValue>
562568
<Docs>
563-
<summary>To be added.</summary>
564-
<value>To be added.</value>
569+
<summary>Gets or sets the geographical locale and language in which to report exception messages.</summary>
570+
<value>An integer value representing the locale in which exception messages are to be reported.</value>
565571
<remarks>To be added.</remarks>
566572
</Docs>
567573
</Member>
@@ -588,8 +594,8 @@
588594
<Parameter Name="Site" Type="Microsoft.Vsa.IVsaPersistSite" />
589595
</Parameters>
590596
<Docs>
591-
<param name="Site">To be added.</param>
592-
<summary>To be added.</summary>
597+
<param name="Site">The site from which the specified source items is loaded.</param>
598+
<summary>Directs the script engine to load source items from their point of persistence, as specified by the host-provided object that implements the <see cref="T:Microsoft.Vsa.IVsaPersistSite" /> interface.</summary>
593599
<remarks>To be added.</remarks>
594600
</Docs>
595601
</Member>
@@ -634,8 +640,8 @@
634640
<ReturnType>System.String</ReturnType>
635641
</ReturnValue>
636642
<Docs>
637-
<summary>To be added.</summary>
638-
<value>To be added.</value>
643+
<summary>Gets or sets the display name of the script engine that is used primarily for identifying individual script engines to users in a hosted environment.</summary>
644+
<value>The value of the script engine's Name property, which may be the empty string.</value>
639645
<remarks>To be added.</remarks>
640646
</Docs>
641647
</Member>
@@ -660,7 +666,7 @@
660666
</ReturnValue>
661667
<Parameters />
662668
<Docs>
663-
<summary>To be added.</summary>
669+
<summary>Removes the script engine from the running state and disconnects automatically bound event handlers.</summary>
664670
<remarks>To be added.</remarks>
665671
</Docs>
666672
</Member>
@@ -685,7 +691,7 @@
685691
</ReturnValue>
686692
<Parameters />
687693
<Docs>
688-
<summary>To be added.</summary>
694+
<summary>Invalidates the cached assembly for the engine, as specified by its root moniker.</summary>
689695
<remarks>To be added.</remarks>
690696
</Docs>
691697
</Member>
@@ -709,8 +715,8 @@
709715
<ReturnType>System.String</ReturnType>
710716
</ReturnValue>
711717
<Docs>
712-
<summary>To be added.</summary>
713-
<value>To be added.</value>
718+
<summary>Gets or sets a script engine's root moniker.</summary>
719+
<value>The current value of the RootMoniker property.</value>
714720
<remarks>To be added.</remarks>
715721
</Docs>
716722
</Member>
@@ -734,8 +740,8 @@
734740
<ReturnType>System.String</ReturnType>
735741
</ReturnValue>
736742
<Docs>
737-
<summary>To be added.</summary>
738-
<value>To be added.</value>
743+
<summary>Gets or sets the root namespace used by the script engine.</summary>
744+
<value>The string value of the root namespace.</value>
739745
<remarks>To be added.</remarks>
740746
</Docs>
741747
</Member>
@@ -760,7 +766,7 @@
760766
</ReturnValue>
761767
<Parameters />
762768
<Docs>
763-
<summary>To be added.</summary>
769+
<summary>Initiates execution of compiled code in the script engine and binds all event handlers.</summary>
764770
<remarks>To be added.</remarks>
765771
</Docs>
766772
</Member>
@@ -788,9 +794,9 @@
788794
<Parameter Name="PDB" Type="System.Byte[]" RefType="out" />
789795
</Parameters>
790796
<Docs>
791-
<param name="PE">To be added.</param>
792-
<param name="PDB">To be added.</param>
793-
<summary>To be added.</summary>
797+
<param name="PE">The compiled state of the script engine.</param>
798+
<param name="PDB">Specifies debugging information contained in the .PDB file corresponding to the PE (portable executable).</param>
799+
<summary>Saves the compiled state of the script engine; optionally, it also saves debugging information.</summary>
794800
<remarks>To be added.</remarks>
795801
</Docs>
796802
</Member>
@@ -817,8 +823,8 @@
817823
<Parameter Name="Site" Type="Microsoft.Vsa.IVsaPersistSite" />
818824
</Parameters>
819825
<Docs>
820-
<param name="Site">To be added.</param>
821-
<summary>To be added.</summary>
826+
<param name="Site">The site established by the <see cref="T:Microsoft.Vsa.IVsaPersistSite" /> interface to which source state is saved.</param>
827+
<summary>Directs the script engine to persist its source state to the specified <see cref="T:Microsoft.Vsa.IVsaPersistSite" /> object.</summary>
822828
<remarks>To be added.</remarks>
823829
</Docs>
824830
</Member>
@@ -846,9 +852,9 @@
846852
<Parameter Name="value" Type="System.Object" />
847853
</Parameters>
848854
<Docs>
849-
<param name="Name">To be added.</param>
850-
<param name="value">To be added.</param>
851-
<summary>To be added.</summary>
855+
<param name="Name">The name of the option to set.</param>
856+
<param name="value">The value for the option being set.</param>
857+
<summary>Sets implementation-specific options for a script engine.</summary>
852858
<remarks>To be added.</remarks>
853859
</Docs>
854860
</Member>
@@ -872,8 +878,8 @@
872878
<ReturnType>Microsoft.Vsa.IVsaSite</ReturnType>
873879
</ReturnValue>
874880
<Docs>
875-
<summary>To be added.</summary>
876-
<value>To be added.</value>
881+
<summary>Gets or sets the host-implemented <see cref="T:Microsoft.Vsa.IVsaSite" /> object that is used by the script engine to communicate with the host.</summary>
882+
<value>A reference to the current <see cref="T:Microsoft.Vsa.IVsaSite" /> object.</value>
877883
<remarks>To be added.</remarks>
878884
</Docs>
879885
</Member>
@@ -897,8 +903,8 @@
897903
<ReturnType>System.String</ReturnType>
898904
</ReturnValue>
899905
<Docs>
900-
<summary>To be added.</summary>
901-
<value>To be added.</value>
906+
<summary>Gets the current version of the language compiler supported by the script engine, in the form Major.Minor.Revision.Build.</summary>
907+
<value>String value of the current version, in the format Major.Minor.Revision.Build.</value>
902908
<remarks>To be added.</remarks>
903909
</Docs>
904910
</Member>

‎xml/Microsoft.VisualBasic/Collection.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -902,10 +902,10 @@ MsgBox(CStr(customers(1)))
902902
<Parameter Name="Item" Type="System.Object" Index="0" FrameworkAlternate="netframework-1.1" />
903903
</Parameters>
904904
<Docs>
905-
<param name="value">To be added.</param>
906-
<param name="Item">To be added.</param>
907-
<summary>To be added.</summary>
908-
<returns>To be added.</returns>
905+
<param name="value">The item to add to the collection.</param>
906+
<param name="Item">The item to add to the collection.</param>
907+
<summary>Adds an item to the collection.</summary>
908+
<returns>The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection.</returns>
909909
<remarks>To be added.</remarks>
910910
</Docs>
911911
</Member>
@@ -1168,7 +1168,7 @@ MsgBox(CStr(customers(1)))
11681168
<Parameter Name="Index" Type="System.Int32" Index="0" FrameworkAlternate="netframework-1.1" />
11691169
</Parameters>
11701170
<Docs>
1171-
<param name="index">To be added.</param>
1171+
<param name="index">The zero-based index fo the element to get or set.</param>
11721172
<param name="Index">The zero-based index of the element to get or set.</param>
11731173
<summary>Gets or sets the element at the specified index.</summary>
11741174
<value>The element at the specified index.</value>

‎xml/Microsoft.VisualBasic/MsgBoxResult.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
</ReturnValue>
187187
<MemberValue>1</MemberValue>
188188
<Docs>
189-
<summary>To be added.</summary>
189+
<summary>**OK** button was pressed. This member is equivalent to the Visual Basic constant <see langword="vbOK" />.</summary>
190190
</Docs>
191191
</Member>
192192
<Member MemberName="Retry">

0 commit comments

Comments
 (0)