Skip to content

Commit 9b59dbd

Browse files
authored
standardize descriptions (#2220)
* standardize descriptions * standardize descriptions
1 parent 009e629 commit 9b59dbd

File tree

1 file changed

+16
-21
lines changed

1 file changed

+16
-21
lines changed

xml/Microsoft.VisualBasic.ApplicationServices/WindowsFormsApplicationBase.xml

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,7 @@
100100
<Parameter Name="authenticationMode" Type="Microsoft.VisualBasic.ApplicationServices.AuthenticationMode" />
101101
</Parameters>
102102
<Docs>
103-
<param name="authenticationMode">
104-
<see cref="T:Microsoft.VisualBasic.ApplicationServices.AuthenticationMode" />. Specifies the application's authentication mode.</param>
103+
<param name="authenticationMode">One of the enumeration values that specifies the application's authentication mode.</param>
105104
<summary>Initializes a new instance of the <see cref="T:Microsoft.VisualBasic.ApplicationServices.WindowsFormsApplicationBase" /> class with the specified authentication mode.</summary>
106105
<remarks>
107106
<format type="text/markdown"><![CDATA[
@@ -142,7 +141,7 @@
142141
</ReturnValue>
143142
<Docs>
144143
<summary>Gets the <see cref="T:System.Windows.Forms.ApplicationContext" /> object for the current thread of a Windows Forms application.</summary>
145-
<value>This property returns the <see cref="T:System.Windows.Forms.ApplicationContext" /> object for the current thread. That object contains contextual information about the thread.</value>
144+
<value>Contextual information about the current thread.</value>
146145
<remarks>
147146
<format type="text/markdown"><![CDATA[
148147
@@ -350,8 +349,8 @@
350349
<ReturnType>System.Boolean</ReturnType>
351350
</ReturnValue>
352351
<Docs>
353-
<summary>Determines whether this application is a single-instance application.</summary>
354-
<value>A <see cref="T:System.Boolean" /> value that indicates whether this application is a single-instance application.</value>
352+
<summary>Gets or sets a value that indicates whether this application is a single-instance application.</summary>
353+
<value><see langword="True" /> to indicate this application is a single-instance application; otherwise, <see langword="False" />.</value>
355354
<remarks>
356355
<format type="text/markdown"><![CDATA[
357356
@@ -424,9 +423,8 @@
424423
<ReturnType>System.Int32</ReturnType>
425424
</ReturnValue>
426425
<Docs>
427-
<summary>Determines the minimum length of time, in milliseconds, for which the splash screen is displayed.</summary>
428-
<value>
429-
<see langword="Integer" />. The minimum length of time, in milliseconds, for which the splash screen is displayed.</value>
426+
<summary>Gets or sets the minimum length of time, in milliseconds, for which the splash screen is displayed.</summary>
427+
<value>The minimum length of time, in milliseconds, for which the splash screen is displayed.</value>
430428
<remarks>
431429
<format type="text/markdown"><![CDATA[
432430
@@ -653,7 +651,7 @@
653651
<Parameter Name="commandLineArgs" Type="System.Collections.ObjectModel.ReadOnlyCollection&lt;System.String&gt;" />
654652
</Parameters>
655653
<Docs>
656-
<param name="commandLineArgs">A <see cref="T:System.Collections.ObjectModel.ReadOnlyCollection`1" /> of <see langword="String" />, containing the command-line arguments as strings for the current application.</param>
654+
<param name="commandLineArgs">A read-only collection containing the command-line arguments as strings for the current application.</param>
657655
<summary>Sets the visual styles, text display styles, and current principal for the main application thread (if the application uses Windows authentication), and initializes the splash screen, if defined.</summary>
658656
<returns>A <see cref="T:System.Boolean" /> indicating if application startup should continue.</returns>
659657
<remarks>
@@ -786,8 +784,7 @@
786784
<Parameter Name="eventArgs" Type="Microsoft.VisualBasic.ApplicationServices.StartupEventArgs" />
787785
</Parameters>
788786
<Docs>
789-
<param name="eventArgs">
790-
<see cref="T:Microsoft.VisualBasic.ApplicationServices.StartupEventArgs" />. Contains the command-line arguments of the application and indicates whether the application startup should be canceled.</param>
787+
<param name="eventArgs">The command-line arguments of the application and indicates whether the application startup should be canceled.</param>
791788
<summary>When overridden in a derived class, allows for code to run when the application starts.</summary>
792789
<returns>A <see cref="T:System.Boolean" /> that indicates if the application should continue starting up.</returns>
793790
<remarks>
@@ -831,8 +828,7 @@
831828
<Parameter Name="eventArgs" Type="Microsoft.VisualBasic.ApplicationServices.StartupNextInstanceEventArgs" />
832829
</Parameters>
833830
<Docs>
834-
<param name="eventArgs">
835-
<see cref="T:Microsoft.VisualBasic.ApplicationServices.StartupNextInstanceEventArgs" />. Contains the command-line arguments of the subsequent application instance and indicates whether the first application instance should be brought to the foreground upon exiting the exception handler.</param>
831+
<param name="eventArgs">The command-line arguments of the subsequent application instance and indicates whether the first application instance should be brought to the foreground upon exiting the exception handler.</param>
836832
<summary>When overridden in a derived class, allows for code to run when a subsequent instance of a single-instance application starts.</summary>
837833
<remarks>
838834
<format type="text/markdown"><![CDATA[
@@ -873,8 +869,7 @@
873869
<Parameter Name="e" Type="Microsoft.VisualBasic.ApplicationServices.UnhandledExceptionEventArgs" />
874870
</Parameters>
875871
<Docs>
876-
<param name="e">
877-
<see cref="T:Microsoft.VisualBasic.ApplicationServices.UnhandledExceptionEventArgs" />.</param>
872+
<param name="e">The data for the event.</param>
878873
<summary>When overridden in a derived class, allows for code to run when an unhandled exception occurs in the application.</summary>
879874
<returns>A <see cref="T:System.Boolean" /> that indicates whether the <see cref="E:Microsoft.VisualBasic.ApplicationServices.WindowsFormsApplicationBase.UnhandledException" /> event was raised.</returns>
880875
<remarks>
@@ -908,7 +903,7 @@
908903
</ReturnValue>
909904
<Docs>
910905
<summary>Gets a collection of all the application's open forms.</summary>
911-
<value>A <see cref="T:System.Windows.Forms.FormCollection" /> object that contains all of the application's open forms.</value>
906+
<value>A collection that contains all of the application's open forms.</value>
912907
<remarks>
913908
<format type="text/markdown"><![CDATA[
914909
@@ -974,7 +969,7 @@
974969
<Parameter Name="commandLine" Type="System.String[]" />
975970
</Parameters>
976971
<Docs>
977-
<param name="commandLine">Array of type <see langword="String" />. The command line from <see langword="Sub Main" />.</param>
972+
<param name="commandLine">The command line from <see langword="Sub Main" />.</param>
978973
<summary>Sets up and starts the Visual Basic Application model.</summary>
979974
<remarks>
980975
<format type="text/markdown"><![CDATA[
@@ -1034,7 +1029,7 @@
10341029
<Docs>
10351030
<summary>Determines whether the application saves the user settings on exit.</summary>
10361031
<value>
1037-
<see langword="Boolean" />. <see langword="True" /> indicates that the application saves the user settings on exit. Otherwise, the settings are not implicitly saved.</value>
1032+
<see langword="True" /> to indicate that the application saves the user settings on exit. Otherwise, <see langword="False" /> to indicate the settings are not implicitly saved.</value>
10381033
<remarks>
10391034
<format type="text/markdown"><![CDATA[
10401035
@@ -1203,7 +1198,7 @@
12031198
</ReturnValue>
12041199
<Docs>
12051200
<summary>Determines what happens when the application's main form closes.</summary>
1206-
<value>A <see cref="T:Microsoft.VisualBasic.ApplicationServices.ShutdownMode" /> enumeration value, indicating what the application should do when the main form closes.</value>
1201+
<value>One of the enumeration values that indicates what the application should do when the main form closes.</value>
12071202
<remarks>
12081203
<format type="text/markdown"><![CDATA[
12091204
@@ -1238,7 +1233,7 @@
12381233
</ReturnValue>
12391234
<Docs>
12401235
<summary>Gets or sets the splash screen for this application.</summary>
1241-
<value>A <see cref="T:System.Windows.Forms.Form" /> object that the application uses as the splash screen.</value>
1236+
<value>The splash screen for the application.</value>
12421237
<remarks>
12431238
<format type="text/markdown"><![CDATA[
12441239
@@ -1577,4 +1572,4 @@ End Property
15771572
</Docs>
15781573
</Member>
15791574
</Members>
1580-
</Type>
1575+
</Type>

0 commit comments

Comments
 (0)