Skip to content

Commit b0e445e

Browse files
authored
Un-encode characters in xref links (System.NET, System.Messaging, System.IO) (#12459)
1 parent f973440 commit b0e445e

325 files changed

Lines changed: 6967 additions & 6982 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

xml/System.IO.Compression/DeflateStream.xml

Lines changed: 16 additions & 16 deletions
Large diffs are not rendered by default.

xml/System.IO.Compression/GZipStream.xml

Lines changed: 19 additions & 19 deletions
Large diffs are not rendered by default.

xml/System.IO.Compression/ZipArchive.xml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -503,7 +503,7 @@ If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will
503503
## Remarks
504504
The `entryName` string should reflect the relative path of the entry you want to create within the zip archive. There is no restriction on the string you provide. However, if it is not formatted as a relative path, the entry is created, but you may get an exception when you extract the contents of the zip archive. If an entry with the specified path and name already exists in the archive, a second entry is created with the same path and name.
505505
506-
The value of the <xref:System.IO.Compression.ZipArchiveEntry.LastWriteTime> property for the new entry is set to the current time. The entry is compressed using the default compression level of the underlying compression algorithm. If you want to specify a different compression level, use the <xref:System.IO.Compression.ZipArchive.CreateEntry%2A> method.
506+
The value of the <xref:System.IO.Compression.ZipArchiveEntry.LastWriteTime> property for the new entry is set to the current time. The entry is compressed using the default compression level of the underlying compression algorithm. If you want to specify a different compression level, use the <xref:System.IO.Compression.ZipArchive.CreateEntry*> method.
507507
508508
## Examples
509509
The following example shows how to create an entry and write to it by using a stream.
@@ -640,11 +640,11 @@ If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will
640640
<format type="text/markdown"><![CDATA[
641641
642642
## Remarks
643-
This method finishes writing the archive and releases all resources used by the <xref:System.IO.Compression.ZipArchive> object. Unless you construct the object by using the <xref:System.IO.Compression.ZipArchive.%23ctor%28System.IO.Stream%2CSystem.IO.Compression.ZipArchiveMode%2CSystem.Boolean%29> constructor overload and set its `leaveOpen` parameter to `true`, all underlying streams are closed and no longer available for subsequent write operations.
643+
This method finishes writing the archive and releases all resources used by the <xref:System.IO.Compression.ZipArchive> object. Unless you construct the object by using the <xref:System.IO.Compression.ZipArchive.%23ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode,System.Boolean)> constructor overload and set its `leaveOpen` parameter to `true`, all underlying streams are closed and no longer available for subsequent write operations.
644644
645645
When you are finished using this instance of <xref:System.IO.Compression.ZipArchive>, call <xref:System.IO.Compression.ZipArchive.Dispose> to release all resources used by this instance. You should eliminate further references to this <xref:System.IO.Compression.ZipArchive> instance so that the garbage collector can reclaim the memory of the instance instead of keeping it alive for finalization.
646646
647-
<xref:System.IO.Compression.ZipArchive.Dispose> calls the <xref:System.IO.Compression.ZipArchive.Dispose%28System.Boolean%29> method, which contains the code to release managed and unmanaged resources. For more information, see [Implementing a Dispose method](/dotnet/standard/garbage-collection/implementing-dispose).
647+
<xref:System.IO.Compression.ZipArchive.Dispose> calls the <xref:System.IO.Compression.ZipArchive.Dispose(System.Boolean)> method, which contains the code to release managed and unmanaged resources. For more information, see [Implementing a Dispose method](/dotnet/standard/garbage-collection/implementing-dispose).
648648
649649
]]></format>
650650
</remarks>
@@ -692,15 +692,15 @@ If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will
692692
<format type="text/markdown"><![CDATA[
693693
694694
## Remarks
695-
If `disposing` is set to `true`, all underlying streams are closed and no longer available for subsequent write operations, unless you construct the object by using the <xref:System.IO.Compression.ZipArchive.%23ctor%28System.IO.Stream%2CSystem.IO.Compression.ZipArchiveMode%2CSystem.Boolean%29> constructor overload and set its `leaveOpen` parameter to `true`.
695+
If `disposing` is set to `true`, all underlying streams are closed and no longer available for subsequent write operations, unless you construct the object by using the <xref:System.IO.Compression.ZipArchive.%23ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode,System.Boolean)> constructor overload and set its `leaveOpen` parameter to `true`.
696696
697697
This method is called only by the public <xref:System.IO.Compression.ZipArchive.Dispose> and <xref:System.Object.Finalize> methods; do not call this method directly.
698698
699-
When you implement the dispose pattern, the Boolean parameter of the <xref:System.IO.Compression.ZipArchive.Dispose%28System.Boolean%29> method should be used as follows:
699+
When you implement the dispose pattern, the Boolean parameter of the <xref:System.IO.Compression.ZipArchive.Dispose(System.Boolean)> method should be used as follows:
700700
701-
- The <xref:System.IO.Compression.ZipArchive.Dispose> method of the current object should call <xref:System.IO.Compression.ZipArchive.Dispose%28System.Boolean%29> with the Boolean parameter set to `true` to release both managed and unmanaged resources.
701+
- The <xref:System.IO.Compression.ZipArchive.Dispose> method of the current object should call <xref:System.IO.Compression.ZipArchive.Dispose(System.Boolean)> with the Boolean parameter set to `true` to release both managed and unmanaged resources.
702702
703-
- The <xref:System.Object.Finalize> method of the current object should call <xref:System.IO.Compression.ZipArchive.Dispose%28System.Boolean%29> with the Boolean parameter set to `false` to release only unmanaged resources.
703+
- The <xref:System.Object.Finalize> method of the current object should call <xref:System.IO.Compression.ZipArchive.Dispose(System.Boolean)> with the Boolean parameter set to `false` to release only unmanaged resources.
704704
705705
For more information, see [Implementing a Dispose method](/dotnet/standard/garbage-collection/implementing-dispose).
706706
@@ -801,7 +801,7 @@ If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will
801801
<format type="text/markdown"><![CDATA[
802802
803803
## Remarks
804-
Use the <xref:System.IO.Compression.ZipArchive.Entries> property to retrieve the entire collection of entries. Use the <xref:System.IO.Compression.ZipArchive.GetEntry%2A> method to retrieve a single entry by name.
804+
Use the <xref:System.IO.Compression.ZipArchive.Entries> property to retrieve the entire collection of entries. Use the <xref:System.IO.Compression.ZipArchive.GetEntry*> method to retrieve a single entry by name.
805805
806806
## Examples
807807
The following example shows how to open a zip archive and iterate through the collection of entries.
@@ -863,7 +863,7 @@ If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will
863863
If multiple entries that have the specified name exist in the archive, the first one is returned. The name of the entry is compared to `entryName` using ordinal comparison.
864864
865865
## Examples
866-
The following example shows how to use the <xref:System.IO.Compression.ZipArchive.GetEntry%2A> method to retrieve an entry.
866+
The following example shows how to use the <xref:System.IO.Compression.ZipArchive.GetEntry*> method to retrieve an entry.
867867
868868
:::code language="csharp" source="~/snippets/csharp/System.IO.Compression/ZipArchive/GetEntry/program2.cs" id="Snippet2":::
869869
:::code language="fsharp" source="~/snippets/fsharp/System.IO.Compression/ZipArchive/GetEntry/program2.fs" id="Snippet2":::
@@ -918,7 +918,7 @@ If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will
918918
<format type="text/markdown"><![CDATA[
919919
920920
## Remarks
921-
You specify a value for the <xref:System.IO.Compression.ZipArchive> property when you create an instance of the <xref:System.IO.Compression.ZipArchive> class. Use the <xref:System.IO.Compression.ZipArchive.%23ctor%28System.IO.Stream%2CSystem.IO.Compression.ZipArchiveMode%29> or <xref:System.IO.Compression.ZipArchive.%23ctor%28System.IO.Stream%2CSystem.IO.Compression.ZipArchiveMode%2CSystem.Boolean%29> constructor to provide a value for the <xref:System.IO.Compression.ZipArchive.Mode> property.
921+
You specify a value for the <xref:System.IO.Compression.ZipArchive> property when you create an instance of the <xref:System.IO.Compression.ZipArchive> class. Use the <xref:System.IO.Compression.ZipArchive.%23ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode)> or <xref:System.IO.Compression.ZipArchive.%23ctor(System.IO.Stream,System.IO.Compression.ZipArchiveMode,System.Boolean)> constructor to provide a value for the <xref:System.IO.Compression.ZipArchive.Mode> property.
922922
923923
]]></format>
924924
</remarks>

xml/System.IO.Compression/ZipArchiveEntry.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will
172172
This property cannot be retrieved when the mode is set to <xref:System.IO.Compression.ZipArchiveMode.Create>, or the mode is set to <xref:System.IO.Compression.ZipArchiveMode.Update> and the entry has been opened.
173173
174174
## Examples
175-
The following example shows how to retrieve entries in a zip archive, and evaluate the properties of the entries. It uses the <xref:System.IO.Compression.ZipArchiveEntry.Name> property to display the name of the entry, and the <xref:System.IO.Compression.ZipArchiveEntry.Length%2A> and <xref:System.IO.Compression.ZipArchiveEntry.CompressedLength%2A> properties to calculate how much the file was compressed.
175+
The following example shows how to retrieve entries in a zip archive, and evaluate the properties of the entries. It uses the <xref:System.IO.Compression.ZipArchiveEntry.Name> property to display the name of the entry, and the <xref:System.IO.Compression.ZipArchiveEntry.Length*> and <xref:System.IO.Compression.ZipArchiveEntry.CompressedLength*> properties to calculate how much the file was compressed.
176176
177177
:::code language="csharp" source="~/snippets/csharp/System.IO.Compression/ZipArchive/GetEntry/program1.cs" id="Snippet1":::
178178
:::code language="vb" source="~/snippets/visualbasic/System.IO.Compression/ZipArchive/GetEntry/program1.vb" id="Snippet1":::
@@ -488,7 +488,7 @@ If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will
488488
This property cannot be retrieved when the mode is set to <xref:System.IO.Compression.ZipArchiveMode.Create>, or the mode is set to <xref:System.IO.Compression.ZipArchiveMode.Update> and the entry has been opened.
489489
490490
## Examples
491-
The following example shows how to retrieve entries from a zip archive, and evaluate the properties of the entries. It uses the <xref:System.IO.Compression.ZipArchiveEntry.Name> property to display the name of the entry, and the <xref:System.IO.Compression.ZipArchiveEntry.Length%2A> and <xref:System.IO.Compression.ZipArchiveEntry.CompressedLength%2A> properties to calculate how much the file was compressed.
491+
The following example shows how to retrieve entries from a zip archive, and evaluate the properties of the entries. It uses the <xref:System.IO.Compression.ZipArchiveEntry.Name> property to display the name of the entry, and the <xref:System.IO.Compression.ZipArchiveEntry.Length*> and <xref:System.IO.Compression.ZipArchiveEntry.CompressedLength*> properties to calculate how much the file was compressed.
492492
493493
:::code language="csharp" source="~/snippets/csharp/System.IO.Compression/ZipArchive/GetEntry/program1.cs" id="Snippet1":::
494494
:::code language="vb" source="~/snippets/visualbasic/System.IO.Compression/ZipArchive/GetEntry/program1.vb" id="Snippet1":::
@@ -583,7 +583,7 @@ If the comment byte length is larger than <xref:System.UInt16.MaxValue>, it will
583583
You use this method to access the stream for an entry in a zip archive. After retrieving the stream, you can read from or write to the stream. When you write to the stream, the modifications you make to the entry will appear in the zip archive.
584584
585585
## Examples
586-
The following example shows how to create a new entry, open it with the <xref:System.IO.Compression.ZipArchiveEntry.Open%2A> method, and write to the stream.
586+
The following example shows how to create a new entry, open it with the <xref:System.IO.Compression.ZipArchiveEntry.Open*> method, and write to the stream.
587587
588588
:::code language="csharp" source="~/snippets/csharp/System.IO.Compression/ZipArchive/CreateEntry/program1.cs" id="Snippet1":::
589589
:::code language="vb" source="~/snippets/visualbasic/System.IO.Compression/ZipArchive/CreateEntry/program1.vb" id="Snippet1":::

xml/System.IO.Compression/ZipFile.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ An I/O error occurred while opening a file to be archived.</exception>
171171
<format type="text/markdown"><![CDATA[
172172
173173
## Remarks
174-
The directory structure from the file system is preserved in the archive. If the directory is empty, an empty archive is created. This method overload does not include the base directory in the archive and does not allow you to specify a compression level. If you want to include the base directory or specify a compression level, call the <xref:System.IO.Compression.ZipFile.CreateFromDirectory%28System.String%2CSystem.String%2CSystem.IO.Compression.CompressionLevel%2CSystem.Boolean%29> method overload.
174+
The directory structure from the file system is preserved in the archive. If the directory is empty, an empty archive is created. This method overload does not include the base directory in the archive and does not allow you to specify a compression level. If you want to include the base directory or specify a compression level, call the <xref:System.IO.Compression.ZipFile.CreateFromDirectory(System.String,System.String,System.IO.Compression.CompressionLevel,System.Boolean)> method overload.
175175
176176
If the archive already exists, an <xref:System.IO.IOException> exception is thrown. If an entry with the specified name already exists in the archive, a second entry is created with an identical name.
177177
@@ -2509,7 +2509,7 @@ An archive entry has been compressed using a compression method that isn't suppo
25092509
<format type="text/markdown"><![CDATA[
25102510
25112511
## Remarks
2512-
When you set the `mode` parameter to <xref:System.IO.Compression.ZipArchiveMode.Read>, the archive is opened with <xref:System.IO.FileMode.Open> from the <xref:System.IO.FileMode> enumeration as the file mode value. If the archive does not exist, a <xref:System.IO.FileNotFoundException> exception is thrown. Setting the `mode` parameter to <xref:System.IO.Compression.ZipArchiveMode.Read> is equivalent to calling the <xref:System.IO.Compression.ZipFile.OpenRead%2A> method.
2512+
When you set the `mode` parameter to <xref:System.IO.Compression.ZipArchiveMode.Read>, the archive is opened with <xref:System.IO.FileMode.Open> from the <xref:System.IO.FileMode> enumeration as the file mode value. If the archive does not exist, a <xref:System.IO.FileNotFoundException> exception is thrown. Setting the `mode` parameter to <xref:System.IO.Compression.ZipArchiveMode.Read> is equivalent to calling the <xref:System.IO.Compression.ZipFile.OpenRead*> method.
25132513
25142514
When you set the `mode` parameter to <xref:System.IO.Compression.ZipArchiveMode.Create>, the archive is opened with <xref:System.IO.FileMode.CreateNew?displayProperty=nameWithType> as the file mode value. If the archive already exists, an <xref:System.IO.IOException> is thrown.
25152515
@@ -2899,7 +2899,7 @@ An unspecified I/O error occurred while opening the file.</exception>
28992899
<remarks>
29002900
<format type="text/markdown"><![CDATA[
29012901
2902-
This method is equivalent to calling the <xref:System.IO.Compression.ZipFile.Open%2A> method and setting the `mode` parameter to <xref:System.IO.Compression.ZipArchiveMode.Read>. The archive is opened with <xref:System.IO.FileMode.Open?displayProperty=nameWithType> as the file mode value. If the archive does not exist, a <xref:System.IO.FileNotFoundException> exception is thrown.
2902+
This method is equivalent to calling the <xref:System.IO.Compression.ZipFile.Open*> method and setting the `mode` parameter to <xref:System.IO.Compression.ZipArchiveMode.Read>. The archive is opened with <xref:System.IO.FileMode.Open?displayProperty=nameWithType> as the file mode value. If the archive does not exist, a <xref:System.IO.FileNotFoundException> exception is thrown.
29032903
29042904
## Examples
29052905

xml/System.IO.Compression/ZipFileExtensions.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -748,11 +748,11 @@ A <see cref="T:System.IO.Compression.ZipArchiveEntry" /> has been compressed usi
748748
<format type="text/markdown"><![CDATA[
749749
750750
## Remarks
751-
If the destination file already exists, this method does not overwrite it; it throws an <xref:System.IO.IOException> exception. To overwrite an existing file, use the <xref:System.IO.Compression.ZipFileExtensions.ExtractToFile%28System.IO.Compression.ZipArchiveEntry%2CSystem.String%2CSystem.Boolean%29> method overload instead.
751+
If the destination file already exists, this method does not overwrite it; it throws an <xref:System.IO.IOException> exception. To overwrite an existing file, use the <xref:System.IO.Compression.ZipFileExtensions.ExtractToFile(System.IO.Compression.ZipArchiveEntry,System.String,System.Boolean)> method overload instead.
752752
753753
The last write time of the file is set to the last time the entry in the zip archive was changed; this value is stored in the <xref:System.IO.Compression.ZipArchiveEntry.LastWriteTime> property.
754754
755-
You cannot use this method to extract a directory; use the <xref:System.IO.Compression.ZipFileExtensions.ExtractToDirectory%2A> method instead.
755+
You cannot use this method to extract a directory; use the <xref:System.IO.Compression.ZipFileExtensions.ExtractToDirectory*> method instead.
756756
757757
## Examples
758758
The following example shows how to iterate through the contents of a zip archive file and extract files that have a .txt extension.
@@ -854,7 +854,7 @@ A <see cref="T:System.IO.Compression.ZipArchiveEntry" /> has been compressed usi
854854
## Remarks
855855
The last write time of the file is set to the last time the entry in the zip archive was changed; this value is stored in the <xref:System.IO.Compression.ZipArchiveEntry.LastWriteTime> property.
856856
857-
You cannot use this method to extract a directory; use the <xref:System.IO.Compression.ZipFileExtensions.ExtractToDirectory%2A> method instead.
857+
You cannot use this method to extract a directory; use the <xref:System.IO.Compression.ZipFileExtensions.ExtractToDirectory*> method instead.
858858
859859
## Examples
860860
The following example shows how to iterate through the contents of a zip archive file, and extract files that have a .txt extension. It overwrites an existing file that has the same name in the destination folder. In order to compiler this code example, you must reference the `System.IO.Compression` and `System.IO.Compression.FileSystem` assemblies in your project.

0 commit comments

Comments
 (0)