Skip to content

Commit 8515834

Browse files
committed
Fix bad xml escaping of remarks
1 parent 647e69d commit 8515834

File tree

22 files changed

+66
-66
lines changed

22 files changed

+66
-66
lines changed

xml/System.Buffers/ArrayBufferWriter`1.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ This method never returns <xref:System.Span%601.Empty?displayProperty=nameWithTy
387387
<Parameters />
388388
<Docs>
389389
<summary>Resets the data written to the underlying buffer without zeroing its content.</summary>
390-
<remarks>&lt;para&gt;&lt;para&gt; You must reset or clear the &lt;see cref="T:System.Buffers.ArrayBufferWriter`1" /&gt; before trying to re-use it.&lt;/para&gt;&lt;para&gt;&lt;/para&gt;&lt;para&gt; If you reset the writer using the &lt;see cref="M:System.Buffers.ArrayBufferWriter`1.ResetWrittenCount" /&gt; method, the underlying buffer will not be cleared.&lt;/para&gt;&lt;para&gt;&lt;/para&gt;</remarks>
390+
<remarks><para> You must reset or clear the <see cref="T:System.Buffers.ArrayBufferWriter`1" /> before trying to re-use it.</para><para> If you reset the writer using the <see cref="M:System.Buffers.ArrayBufferWriter`1.ResetWrittenCount" /> method, the underlying buffer will not be cleared.</para></remarks>
391391
<seealso cref="M:System.Buffers.ArrayBufferWriter`1.Clear" />
392392
</Docs>
393393
</Member>

xml/System.Diagnostics/Activity.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ Callers should either restrict the number of events added to the same `Activity`
255255
<summary>Add an <see cref="T:System.Diagnostics.ActivityEvent" /> object containing the exception information to the <see cref="P:System.Diagnostics.Activity.Events" /> list.</summary>
256256
<returns>
257257
<see langword="this" /> for convenient chaining.</returns>
258-
<remarks>&lt;para&gt;&lt;para&gt;- The name of the event will be "exception", and it will include the tags "exception.message", "exception.stacktrace", and "exception.type", in addition to the tags provided in the &lt;paramref name="tags" /&gt; parameter.&lt;/para&gt;&lt;para&gt;- Any registered &lt;see cref="T:System.Diagnostics.ActivityListener" /&gt; with the &lt;see cref="P:System.Diagnostics.ActivityListener.ExceptionRecorder" /&gt; callback will be notified about this exception addition before the &lt;see cref="T:System.Diagnostics.ActivityEvent" /&gt; object is added to the &lt;see cref="P:System.Diagnostics.Activity.Events" /&gt; list.&lt;/para&gt;&lt;para&gt;- Any registered &lt;see cref="T:System.Diagnostics.ActivityListener" /&gt; with the &lt;see cref="P:System.Diagnostics.ActivityListener.ExceptionRecorder" /&gt; callback that adds "exception.message", "exception.stacktrace", or "exception.type" tags will not have these tags overwritten, except by any subsequent &lt;see cref="T:System.Diagnostics.ActivityListener" /&gt; that explicitly overwrites them.&lt;/para&gt;</remarks>
258+
<remarks><para>- The name of the event will be "exception", and it will include the tags "exception.message", "exception.stacktrace", and "exception.type", in addition to the tags provided in the <paramref name="tags" /> parameter.</para><para>- Any registered <see cref="T:System.Diagnostics.ActivityListener" /> with the <see cref="P:System.Diagnostics.ActivityListener.ExceptionRecorder" /> callback will be notified about this exception addition before the <see cref="T:System.Diagnostics.ActivityEvent" /> object is added to the <see cref="P:System.Diagnostics.Activity.Events" /> list.</para><para>- Any registered <see cref="T:System.Diagnostics.ActivityListener" /> with the <see cref="P:System.Diagnostics.ActivityListener.ExceptionRecorder" /> callback that adds "exception.message", "exception.stacktrace", or "exception.type" tags will not have these tags overwritten, except by any subsequent <see cref="T:System.Diagnostics.ActivityListener" /> that explicitly overwrites them.</para></remarks>
259259
</Docs>
260260
</Member>
261261
<Member MemberName="AddLink">

xml/System.Diagnostics/ProcessStartInfo.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1747,7 +1747,7 @@ You can use asynchronous read operations to avoid these dependencies and their d
17471747
<para>
17481748
<see langword="true" /> if the user credentials are only to be used for network resources.</para>
17491749
</value>
1750-
<remarks>&lt;para&gt;&lt;para&gt;This property is referenced if the process is being started by using the user name, password, and domain.&lt;/para&gt;&lt;para&gt;If the value is &lt;see langword="true" /&gt;, the process is started with the caller's identity. The system creates a new logon session with the given credentials, which is used on the network only.&lt;/para&gt;&lt;para&gt;The system does not validate the specified credentials. Therefore, the process can start, but it may not have access to network resources.&lt;/para&gt;</remarks>
1750+
<remarks><para>This property is referenced if the process is being started by using the user name, password, and domain.</para><para>If the value is <see langword="true" />, the process is started with the caller's identity. The system creates a new logon session with the given credentials, which is used on the network only.</para><para>The system does not validate the specified credentials. Therefore, the process can start, but it may not have access to network resources.</para></remarks>
17511751
</Docs>
17521752
</Member>
17531753
<Member MemberName="UserName">

xml/System.IO.Compression/ZipArchive.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will
388388
<param name="mode">See the description of the ZipArchiveMode enum. Read requires the stream to support reading, Create requires the stream to support writing, and Update requires the stream to support reading, writing, and seeking.</param>
389389
<param name="leaveOpen">
390390
<see langword="true" /> to leave the stream open upon disposing the ZipArchive, otherwise <see langword="false" />.</param>
391-
<param name="entryNameEncoding">&lt;para&gt;The encoding to use when reading or writing entry names and comments in this ZipArchive.&lt;/para&gt;&lt;para&gt;/// &lt;para&gt;NOTE: Specifying this parameter to values other than &lt;see langword="null" /&gt; is discouraged.&lt;/para&gt;&lt;para&gt;However, this may be necessary for interoperability with ZIP archive tools and libraries that do not correctly support UTF-8 encoding for entry names.&lt;br /&gt; This value is used as follows:&lt;/para&gt;&lt;para&gt; &lt;strong&gt;Reading (opening) ZIP archive files:&lt;/strong&gt; &lt;/para&gt;&lt;para&gt;If &lt;c&gt;entryNameEncoding&lt;/c&gt; is not specified (&lt;c&gt;== null&lt;/c&gt;):&lt;/para&gt;&lt;list&gt; &lt;item&gt;For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header is &lt;em&gt;not&lt;/em&gt; set, use the current system default code page (&lt;c&gt;Encoding.Default&lt;/c&gt;) in order to decode the entry name and comment.&lt;/item&gt; &lt;item&gt;For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header &lt;em&gt;is&lt;/em&gt; set, use UTF-8 (&lt;c&gt;Encoding.UTF8&lt;/c&gt;) in order to decode the entry name and comment.&lt;/item&gt; &lt;/list&gt;&lt;para&gt;If &lt;c&gt;entryNameEncoding&lt;/c&gt; is specified (&lt;c&gt;!= null&lt;/c&gt;):&lt;/para&gt;&lt;list&gt; &lt;item&gt;For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header is &lt;em&gt;not&lt;/em&gt; set, use the specified &lt;c&gt;entryNameEncoding&lt;/c&gt; in order to decode the entry name and comment.&lt;/item&gt; &lt;item&gt;For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header &lt;em&gt;is&lt;/em&gt; set, use UTF-8 (&lt;c&gt;Encoding.UTF8&lt;/c&gt;) in order to decode the entry name and comment.&lt;/item&gt; &lt;/list&gt;&lt;para&gt; &lt;strong&gt;Writing (saving) ZIP archive files:&lt;/strong&gt; &lt;/para&gt;&lt;para&gt;If &lt;c&gt;entryNameEncoding&lt;/c&gt; is not specified (&lt;c&gt;== null&lt;/c&gt;):&lt;/para&gt;&lt;list&gt; &lt;item&gt;For entry names and comments that contain characters outside the ASCII range, the language encoding flag (EFS) will be set in the general purpose bit flag of the local file header, and UTF-8 (&lt;c&gt;Encoding.UTF8&lt;/c&gt;) will be used in order to encode the entry name and comment into bytes.&lt;/item&gt; &lt;item&gt;For entry names and comments that do not contain characters outside the ASCII range, the language encoding flag (EFS) will not be set in the general purpose bit flag of the local file header, and the current system default code page (&lt;c&gt;Encoding.Default&lt;/c&gt;) will be used to encode the entry names and comments into bytes.&lt;/item&gt; &lt;/list&gt;&lt;para&gt;If &lt;c&gt;entryNameEncoding&lt;/c&gt; is specified (&lt;c&gt;!= null&lt;/c&gt;):&lt;/para&gt;&lt;list&gt; &lt;item&gt;The specified &lt;c&gt;entryNameEncoding&lt;/c&gt; will always be used to encode the entry names and comments into bytes.&lt;/para&gt;&lt;para&gt;The language encoding flag (EFS) in the general purpose bit flag of the local file header will be set if and only if the specified &lt;c&gt;entryNameEncoding&lt;/c&gt; is a UTF-8 encoding.&lt;/item&gt; &lt;/list&gt;&lt;para&gt;Note that Unicode encodings other than UTF-8 may not be currently used for the &lt;c&gt;entryNameEncoding&lt;/c&gt;, otherwise an &lt;see cref="T:System.ArgumentException" /&gt; is thrown.&lt;/para&gt;</param>
391+
<param name="entryNameEncoding"><para>The encoding to use when reading or writing entry names and comments in this ZipArchive.</para><para>NOTE: Specifying this parameter to values other than <see langword="null" /> is discouraged.</para><para>However, this may be necessary for interoperability with ZIP archive tools and libraries that do not correctly support UTF-8 encoding for entry names.&lt;br /&gt; This value is used as follows:</para><para> <strong>Reading (opening) ZIP archive files:</strong></para><para>If <c>entryNameEncoding</c> is not specified (<c>== null</c>):</para><list> <item>For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header is <em>not</em> set, use the current system default code page (<c>Encoding.Default</c>) in order to decode the entry name and comment.</item> <item>For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header <em>is</em> set, use UTF-8 (<c>Encoding.UTF8</c>) in order to decode the entry name and comment.</item> </list><para>If <c>entryNameEncoding</c> is specified (<c>!= null</c>):</para><list> <item>For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header is <em>not</em> set, use the specified <c>entryNameEncoding</c> in order to decode the entry name and comment.</item> <item>For entries where the language encoding flag (EFS) in the general purpose bit flag of the local file header <em>is</em> set, use UTF-8 (<c>Encoding.UTF8</c>) in order to decode the entry name and comment.</item> </list><para> <strong>Writing (saving) ZIP archive files:</strong> </para><para>If <c>entryNameEncoding</c> is not specified (<c>== null</c>):</para><list> <item>For entry names and comments that contain characters outside the ASCII range, the language encoding flag (EFS) will be set in the general purpose bit flag of the local file header, and UTF-8 (<c>Encoding.UTF8</c>) will be used in order to encode the entry name and comment into bytes.</item> <item>For entry names and comments that do not contain characters outside the ASCII range, the language encoding flag (EFS) will not be set in the general purpose bit flag of the local file header, and the current system default code page (<c>Encoding.Default</c>) will be used to encode the entry names and comments into bytes.</item> </list><para>If <c>entryNameEncoding</c> is specified (<c>!= null</c>):</para><list> <item>The specified <c>entryNameEncoding</c> will always be used to encode the entry names and comments into bytes.</para><para>The language encoding flag (EFS) in the general purpose bit flag of the local file header will be set if and only if the specified <c>entryNameEncoding</c> is a UTF-8 encoding.</item> </list><para>Note that Unicode encodings other than UTF-8 may not be currently used for the <c>entryNameEncoding</c>, otherwise an <see cref="T:System.ArgumentException" /> is thrown.</para></param>
392392
<param name="cancellationToken">The optional cancellation token to monitor.</param>
393393
<summary>Asynchronously initializes and returns a new instance of <see cref="T:System.IO.Compression.ZipArchive" /> on the given stream in the specified mode, specifying whether to leave the stream open, with an optional encoding and an optional cancellation token.</summary>
394394
<returns>To be added.</returns>
@@ -407,7 +407,7 @@ If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will
407407
<para>-or-</para>
408408
<para>mode is Update and an entry is too large to fit into memory.</para>
409409
</exception>
410-
<exception cref="T:System.ArgumentException">If a Unicode encoding other than UTF-8 is specified for the <code>entryNameEncoding</code>.</exception>
410+
<exception cref="T:System.ArgumentException">If a Unicode encoding other than UTF-8 is specified for the <c>entryNameEncoding</c>.</exception>
411411
</Docs>
412412
</Member>
413413
<MemberGroup MemberName="CreateEntry">

0 commit comments

Comments
 (0)