Skip to content

Commit c51dea0

Browse files
authored
Merge pull request #3880 from dotnet/master
Update live with current master
2 parents a8ff98b + 6d5ca4a commit c51dea0

File tree

13 files changed

+67
-49
lines changed

13 files changed

+67
-49
lines changed

xml/Microsoft.JScript.Vsa/ResInfo.xml

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,19 @@
5454
<Parameter Name="isLinked" Type="System.Boolean" />
5555
</Parameters>
5656
<Docs>
57-
<param name="resinfo">To be added.</param>
58-
<param name="isLinked">To be added.</param>
59-
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
60-
<remarks>To be added.</remarks>
57+
<param name="resinfo">Resource information.</param>
58+
<param name="isLinked">
59+
<see langword="true" /> to indicate the resource is linked; otherwise, <see langword="false" />.</param>
60+
<summary>Initializes a new instance of the <see cref="T:Microsoft.JScript.Vsa.ResInfo" /> class with the specified resource information.</summary>
61+
<remarks>
62+
<format type="text/markdown"><![CDATA[
63+
64+
## Remarks
65+
66+
The `resinfo` parameter should be in the format `<filename>[,<name>[,public|private]]`.
67+
68+
]]></format>
69+
</remarks>
6170
<forInternalUseOnly />
6271
</Docs>
6372
</Member>
@@ -82,11 +91,13 @@
8291
<Parameter Name="isLinked" Type="System.Boolean" />
8392
</Parameters>
8493
<Docs>
85-
<param name="filename">To be added.</param>
86-
<param name="name">To be added.</param>
87-
<param name="isPublic">To be added.</param>
88-
<param name="isLinked">To be added.</param>
89-
<summary>This class, member, or property is internal to the script engine and should not be called from your code.</summary>
94+
<param name="filename">The file name.</param>
95+
<param name="name">Specifies a name.</param>
96+
<param name="isPublic">
97+
<see langword="true" /> to indicate <paramref name="filename" /> is public in the assembly; otherwise, <see langword="false" />.</param>
98+
<param name="isLinked">
99+
<see langword="true" /> to indicate the resource is linked; otherwise, <see langword="false" />.</param>
100+
<summary>Initializes a new instance of the <see cref="T:Microsoft.JScript.Vsa.ResInfo" /> class with the specified resource information in separate parameters.</summary>
90101
<remarks>To be added.</remarks>
91102
<forInternalUseOnly />
92103
</Docs>

xml/Microsoft.Vsa/VsaException.xml

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,10 @@
8686
<Parameter Name="message" Type="System.String" Index="0" FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5" />
8787
</Parameters>
8888
<Docs>
89-
<param name="message">To be added.</param>
90-
<summary>This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
89+
<param name="message">The error message that specifies the reason for the exception.</param>
90+
<summary>Initializes a new instance of the <see cref="T:Microsoft.Vsa.VsaException" /> class with the specified error message.</summary>
9191
<remarks>To be added.</remarks>
92+
<forInternalUseOnly />
9293
</Docs>
9394
</Member>
9495
<Member MemberName=".ctor">
@@ -158,10 +159,11 @@
158159
<Parameter Name="innerException" Type="System.Exception" Index="1" FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5" />
159160
</Parameters>
160161
<Docs>
161-
<param name="message">To be added.</param>
162-
<param name="innerException">To be added.</param>
163-
<summary>This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
162+
<param name="message">The error message that explains the reason for the exception.</param>
163+
<param name="innerException">The exception that is the cause of the current exception.</param>
164+
<summary>Initializes a new instance of the <see cref="T:Microsoft.Vsa.VsaException" /> class with the specified error message and a reference to the inner exception.</summary>
164165
<remarks>To be added.</remarks>
166+
<forInternalUseOnly />
165167
</Docs>
166168
</Member>
167169
<Member MemberName=".ctor">
@@ -183,11 +185,12 @@
183185
<Parameter Name="innerException" Type="System.Exception" />
184186
</Parameters>
185187
<Docs>
186-
<param name="error">To be added.</param>
187-
<param name="message">To be added.</param>
188-
<param name="innerException">To be added.</param>
189-
<summary>This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
188+
<param name="error">One of the enumeration values that specifies the kind of error.</param>
189+
<param name="message">The error message that explains the reason for the exception.</param>
190+
<param name="innerException">The exception that is the cause of the current exception.</param>
191+
<summary>Initializes a new instance of the <see cref="T:Microsoft.Vsa.VsaException" /> class with the specified error type, error message, and a reference to the inner exception.</summary>
190192
<remarks>To be added.</remarks>
193+
<forInternalUseOnly />
191194
</Docs>
192195
</Member>
193196
<Member MemberName="ErrorCode">

xml/Microsoft.Vsa/VsaLoader.xml

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -198,9 +198,10 @@
198198
<Parameter Name="name" Type="System.String" />
199199
</Parameters>
200200
<Docs>
201-
<param name="name">To be added.</param>
202-
<summary>This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
201+
<param name="name">The name of the option to get.</param>
202+
<summary>Gets implementation-specific options.</summary>
203203
<returns>To be added.</returns>
204+
<forInternalUseOnly />
204205
<remarks>To be added.</remarks>
205206
</Docs>
206207
</Member>
@@ -327,10 +328,11 @@
327328
<Parameter Name="identifier" Type="System.String" />
328329
</Parameters>
329330
<Docs>
330-
<param name="identifier">To be added.</param>
331-
<summary>This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
331+
<param name="identifier">A string value provided as identifier.</param>
332+
<summary>Checks whether the supplied identifier is valid.</summary>
332333
<returns>To be added.</returns>
333334
<remarks>To be added.</remarks>
335+
<forInternalUseOnly />
334336
</Docs>
335337
</Member>
336338
<Member MemberName="Items">
@@ -671,10 +673,11 @@
671673
<Parameter Name="value" Type="System.Object" />
672674
</Parameters>
673675
<Docs>
674-
<param name="name">To be added.</param>
675-
<param name="value">To be added.</param>
676-
<summary>This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.</summary>
676+
<param name="name">The name of the option to set.</param>
677+
<param name="value">The value for the option being set.</param>
678+
<summary>Sets implementation-specific options.</summary>
677679
<remarks>To be added.</remarks>
680+
<forInternalUseOnly />
678681
</Docs>
679682
</Member>
680683
<Member MemberName="Site">

xml/Microsoft_VsaVb/VsaEngineClass.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -506,7 +506,7 @@
506506
<Parameter Name="Site" Type="Microsoft.Vsa.IVsaPersistSite" />
507507
</Parameters>
508508
<Docs>
509-
<param name="Site">To be added.</param>
509+
<param name="Site">The site from which the specified source items is loaded.</param>
510510
<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>
511511
<remarks>To be added.</remarks>
512512
<forInternalUseOnly />

xml/System.Drawing.Design/IconEditor.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@
123123
<Parameter Name="e" Type="System.Drawing.Design.IconEditor" Index="0" FrameworkAlternate="netframework-1.1;netframework-2.0;netframework-3.0;netframework-3.5;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" />
124124
</Parameters>
125125
<Docs>
126-
<param name="editor">To be added.</param>
126+
<param name="editor">The <see cref="T:System.Drawing.Design.IconEditor" /> for which the filter string will be created.</param>
127127
<param name="e">The <see cref="T:System.Drawing.Design.IconEditor" /> for which the filter string will be created.</param>
128128
<summary>Creates a filter string for the file dialog box.</summary>
129129
<returns>The filter string, created from the string returned by <see cref="M:System.Drawing.Design.IconEditor.CreateExtensionsString(System.String[],System.String)" />.</returns>

xml/System.Net/FileWebResponse.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,8 @@
290290
<Parameter Name="disposing" Type="System.Boolean" Index="0" FrameworkAlternate="netframework-1.1" />
291291
</Parameters>
292292
<Docs>
293-
<param name="disposing">To be added.</param>
293+
<param name="disposing">
294+
<see langword="true" /> to release both managed and unmanaged resources; otherwise, <see langword="false" />.</param>
294295
<summary>Releases the unmanaged resources used by the <see cref="T:System.Net.FileWebResponse" /> and optionally releases the managed resources.</summary>
295296
<remarks>To be added.</remarks>
296297
</Docs>

xml/System.Net/WriteStreamClosedEventHandler.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
<ReturnType>System.Void</ReturnType>
3636
</ReturnValue>
3737
<Docs>
38-
<param name="sender">To be added.</param>
39-
<param name="e">To be added.</param>
38+
<param name="sender">The source of the event.</param>
39+
<param name="e">The event data.</param>
4040
<summary>Represents the method that will handle the <see cref="E:System.Net.WebClient.WriteStreamClosed" /> event of a <see cref="T:System.Net.WebClient" />.</summary>
4141
<remarks>To be added.</remarks>
4242
</Docs>

xml/System.ServiceModel.Channels/UdpTransportBindingElement.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@
419419
</Parameters>
420420
<Docs>
421421
<param name="importer">The <see cref="T:System.ServiceModel.Description.MetadataImporter" /> object in use.</param>
422-
<param name="policyContext">To be added.</param>
422+
<param name="policyContext">The policy context.</param>
423423
<summary>Imports custom policy assertions and adds implementing binding elements.</summary>
424424
<remarks>To be added.</remarks>
425425
</Docs>

xml/System.Threading/WaitHandle.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -890,7 +890,7 @@ Calling `Dispose` allows the resources used by the <xref:System.Threading.WaitHa
890890

891891
-or-
892892

893-
The current thread is <see cref="F:System.Threading.ApartmentState.STA" /> state, and <paramref name="waitHandles" /> contains more than one element.</exception>
893+
The current thread is in <see cref="F:System.Threading.ApartmentState.STA" /> state, and <paramref name="waitHandles" /> contains more than one element.</exception>
894894
<exception cref="T:System.ApplicationException">
895895
<paramref name="waitHandles" /> is an array with no elements and the .NET Framework version is 1.0 or 1.1.</exception>
896896
<exception cref="T:System.Threading.AbandonedMutexException">The wait terminated because a thread exited without releasing a mutex. This exception is not thrown on Windows 98 or Windows Millennium Edition.</exception>

xml/System.Web.Hosting/LowPhysicalMemoryObserver.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@
112112
<Parameter Name="lowMemoryInfo" Type="System.Web.Hosting.LowPhysicalMemoryInfo" />
113113
</Parameters>
114114
<Docs>
115-
<param name="lowMemoryInfo">To be added.</param>
115+
<param name="lowMemoryInfo">The new data to send to the observer.</param>
116116
<summary>Provides the observer with new data.</summary>
117117
<remarks>To be added.</remarks>
118118
</Docs>

0 commit comments

Comments
 (0)