From b77446d2891b3ffdbe47539e1f043bf0b65398db Mon Sep 17 00:00:00 2001 From: carlossanlop Date: Mon, 29 Aug 2022 15:48:46 -0700 Subject: [PATCH 1/2] Port System.Formats.Tar missing docs --- xml/System.Formats.Tar/GnuTarEntry.xml | 9 ++++++++- xml/System.Formats.Tar/PaxTarEntry.xml | 9 ++++++++- xml/System.Formats.Tar/TarReader.xml | 2 +- xml/System.Formats.Tar/TarWriter.xml | 4 ++-- xml/System.Formats.Tar/UstarTarEntry.xml | 9 ++++++++- xml/System.Formats.Tar/V7TarEntry.xml | 9 ++++++++- 6 files changed, 35 insertions(+), 7 deletions(-) diff --git a/xml/System.Formats.Tar/GnuTarEntry.xml b/xml/System.Formats.Tar/GnuTarEntry.xml index 1f50ace838c..2fe0040862c 100644 --- a/xml/System.Formats.Tar/GnuTarEntry.xml +++ b/xml/System.Formats.Tar/GnuTarEntry.xml @@ -42,9 +42,16 @@ Even though the format is not POSIX - To be added. + The instance to convert to the GNU format. Initializes a new instance by converting the specified entry into the GNU format. To be added. + + is a instance. + +-or- + +The entry type of is not supported in GNU. + The format of is invalid. diff --git a/xml/System.Formats.Tar/PaxTarEntry.xml b/xml/System.Formats.Tar/PaxTarEntry.xml index c2c40297dc8..92634cf00d6 100644 --- a/xml/System.Formats.Tar/PaxTarEntry.xml +++ b/xml/System.Formats.Tar/PaxTarEntry.xml @@ -34,9 +34,16 @@ - To be added. + The instance to convert to the PAX format. Initializes a new instance by converting the specified entry into the PAX format. To be added. + + is a instance. + +-or- + +The entry type of is not supported in PAX. + The format of is invalid. diff --git a/xml/System.Formats.Tar/TarReader.xml b/xml/System.Formats.Tar/TarReader.xml index 34ca30d8d47..b05d4a32207 100644 --- a/xml/System.Formats.Tar/TarReader.xml +++ b/xml/System.Formats.Tar/TarReader.xml @@ -103,7 +103,7 @@ The property of any entry can be r Asynchronously disposes the current instance, and disposes the streams of all the entries that were read from the archive. - To be added. + A value task that represents the asynchronous dispose operation. for its f Asynchronously disposes the current instance, and closes the archive stream if the leaveOpen argument was set to in the constructor. - To be added. + A value task that represents the asynchronous dispose operation. To be added. @@ -292,7 +292,7 @@ These are the entry types supported for writing on each format: The tar entry to write. The token to monitor for cancellation requests. The default value is . Asynchronously writes the specified entry into the archive stream. - To be added. + A task that represents the asynchronous write operation. - To be added. + The instance to convert to the Ustar format. Initializes a new instance by converting the specified entry into the Ustar format. To be added. + + is a instance. + +-or- + +The entry type of is not supported in Ustar. + The format of is invalid. diff --git a/xml/System.Formats.Tar/V7TarEntry.xml b/xml/System.Formats.Tar/V7TarEntry.xml index 006d388099b..000003b4c2b 100644 --- a/xml/System.Formats.Tar/V7TarEntry.xml +++ b/xml/System.Formats.Tar/V7TarEntry.xml @@ -34,9 +34,16 @@ - To be added. + The instance to convert to the V7 format. Initializes a new instance by converting the specified entry into the V7 format. To be added. + + is a instance. + +-or- + +The entry type of is not supported in V7. + The format of is invalid. From 0e5ba1d7808e24bb07d0d423b00a5719017bf09e Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Mon, 29 Aug 2022 23:27:03 -0700 Subject: [PATCH 2/2] Apply suggestions from code review in the runtime triple slash comments PR --- xml/System.Formats.Tar/GnuTarEntry.xml | 2 +- xml/System.Formats.Tar/PaxTarEntry.xml | 2 +- xml/System.Formats.Tar/TarReader.xml | 2 +- xml/System.Formats.Tar/UstarTarEntry.xml | 2 +- xml/System.Formats.Tar/V7TarEntry.xml | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/xml/System.Formats.Tar/GnuTarEntry.xml b/xml/System.Formats.Tar/GnuTarEntry.xml index 2fe0040862c..fced701c8ee 100644 --- a/xml/System.Formats.Tar/GnuTarEntry.xml +++ b/xml/System.Formats.Tar/GnuTarEntry.xml @@ -50,7 +50,7 @@ Even though the format is not POSIX -or- -The entry type of is not supported in GNU. +The entry type of is not supported in the GNU format. The format of is invalid. diff --git a/xml/System.Formats.Tar/PaxTarEntry.xml b/xml/System.Formats.Tar/PaxTarEntry.xml index 92634cf00d6..15548728eea 100644 --- a/xml/System.Formats.Tar/PaxTarEntry.xml +++ b/xml/System.Formats.Tar/PaxTarEntry.xml @@ -42,7 +42,7 @@ -or- -The entry type of is not supported in PAX. +The entry type of is not supported in the PAX format. The format of is invalid. diff --git a/xml/System.Formats.Tar/TarReader.xml b/xml/System.Formats.Tar/TarReader.xml index b05d4a32207..4f68d872e65 100644 --- a/xml/System.Formats.Tar/TarReader.xml +++ b/xml/System.Formats.Tar/TarReader.xml @@ -102,7 +102,7 @@ The property of any entry can be r - Asynchronously disposes the current instance, and disposes the streams of all the entries that were read from the archive. + Asynchronously disposes the current instance, and closes the streams of all the entries that were read from the archive if the leaveOpen argument was set to in the constructor. A value task that represents the asynchronous dispose operation. is not supported in Ustar. +The entry type of is not supported in the Ustar format. The format of is invalid. diff --git a/xml/System.Formats.Tar/V7TarEntry.xml b/xml/System.Formats.Tar/V7TarEntry.xml index 000003b4c2b..6a17e14e619 100644 --- a/xml/System.Formats.Tar/V7TarEntry.xml +++ b/xml/System.Formats.Tar/V7TarEntry.xml @@ -42,7 +42,7 @@ -or- -The entry type of is not supported in V7. +The entry type of is not supported in the V7 format. The format of is invalid.