Skip to content

Port missing docs for System.Formats.Tar #8345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carlossanlop merged 2 commits into from
Aug 30, 2022
Merged

Port missing docs for System.Formats.Tar #8345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b77446d
Port System.Formats.Tar missing docs
carlossanlop Aug 29, 2022
0e5ba1d
Apply suggestions from code review in the runtime triple slash commen…
carlossanlop Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion xml/System.Formats.Tar/GnuTarEntry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,16 @@ Even though the <xref:System.Formats.Tar.TarEntryFormat.Gnu> format is not POSIX
<Parameter Name="other" Type="System.Formats.Tar.TarEntry" />
</Parameters>
<Docs>
<param name="other">To be added.</param>
<param name="other">The <see cref="T:System.Formats.Tar.TarEntry" /> instance to convert to the GNU format.</param>
<summary>Initializes a new <see cref="T:System.Formats.Tar.GnuTarEntry" /> instance by converting the specified <paramref name="other" /> entry into the GNU format.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">
<paramref name="other" /> is a <see cref="T:System.Formats.Tar.PaxGlobalExtendedAttributesTarEntry" /> instance.

-or-

The entry type of <paramref name="other" /> is not supported in the GNU format.</exception>
<exception cref="T:System.FormatException">The format of <paramref name="other" /> is invalid.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down
9 changes: 8 additions & 1 deletion xml/System.Formats.Tar/PaxTarEntry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,16 @@
<Parameter Name="other" Type="System.Formats.Tar.TarEntry" />
</Parameters>
<Docs>
<param name="other">To be added.</param>
<param name="other">The <see cref="T:System.Formats.Tar.TarEntry" /> instance to convert to the PAX format.</param>
<summary>Initializes a new <see cref="T:System.Formats.Tar.PaxTarEntry" /> instance by converting the specified <paramref name="other" /> entry into the PAX format.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">
<paramref name="other" /> is a <see cref="T:System.Formats.Tar.PaxGlobalExtendedAttributesTarEntry" /> instance.

-or-

The entry type of <paramref name="other" /> is not supported in the PAX format.</exception>
<exception cref="T:System.FormatException">The format of <paramref name="other" /> is invalid.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Formats.Tar/TarReader.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ The <xref:System.Formats.Tar.TarEntry.DataStream> property of any entry can be r
</ReturnValue>
<Parameters />
<Docs>
<summary>Asynchronously disposes the current <see cref="T:System.Formats.Tar.TarReader" /> instance, and disposes the streams of all the entries that were read from the archive.</summary>
<returns>To be added.</returns>
<summary>Asynchronously disposes the current <see cref="T:System.Formats.Tar.TarReader" /> instance, and closes the streams of all the entries that were read from the archive if the <c>leaveOpen</c> argument was set to <see langword="false"/> in the constructor.</summary>
<returns>A value task that represents the asynchronous dispose operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down
4 changes: 2 additions & 2 deletions xml/System.Formats.Tar/TarWriter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ The recommended format is <xref:System.Formats.Tar.TarEntryFormat.Pax> for its f
<Parameters />
<Docs>
<summary>Asynchronously disposes the current <see cref="T:System.Formats.Tar.TarWriter" /> instance, and closes the archive stream if the <c>leaveOpen</c> argument was set to <see langword="false" /> in the constructor.</summary>
<returns>To be added.</returns>
<returns>A value task that represents the asynchronous dispose operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -292,7 +292,7 @@ These are the entry types supported for writing on each format:
<param name="entry">The tar entry to write.</param>
<param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Asynchronously writes the specified entry into the archive stream.</summary>
<returns>To be added.</returns>
<returns>A task that represents the asynchronous write operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down
9 changes: 8 additions & 1 deletion xml/System.Formats.Tar/UstarTarEntry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,16 @@
<Parameter Name="other" Type="System.Formats.Tar.TarEntry" />
</Parameters>
<Docs>
<param name="other">To be added.</param>
<param name="other">The <see cref="T:System.Formats.Tar.TarEntry" /> instance to convert to the Ustar format.</param>
<summary>Initializes a new <see cref="T:System.Formats.Tar.UstarTarEntry" /> instance by converting the specified <paramref name="other" /> entry into the Ustar format.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">
<paramref name="other" /> is a <see cref="T:System.Formats.Tar.PaxGlobalExtendedAttributesTarEntry" /> instance.

-or-

The entry type of <paramref name="other" /> is not supported in the Ustar format.</exception>
<exception cref="T:System.FormatException">The format of <paramref name="other" /> is invalid.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down
9 changes: 8 additions & 1 deletion xml/System.Formats.Tar/V7TarEntry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,16 @@
<Parameter Name="other" Type="System.Formats.Tar.TarEntry" />
</Parameters>
<Docs>
<param name="other">To be added.</param>
<param name="other">The <see cref="T:System.Formats.Tar.TarEntry" /> instance to convert to the V7 format.</param>
<summary>Initializes a new <see cref="T:System.Formats.Tar.V7TarEntry" /> instance by converting the specified <paramref name="other" /> entry into the V7 format.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">
<paramref name="other" /> is a <see cref="T:System.Formats.Tar.PaxGlobalExtendedAttributesTarEntry" /> instance.

-or-

The entry type of <paramref name="other" /> is not supported in the V7 format.</exception>
<exception cref="T:System.FormatException">The format of <paramref name="other" /> is invalid.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down