Skip to content

Fix Image.Identify/IdentifyAsync byte array/file overloads still referring to a stream argument in documentation #2207

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

Closed
UnknownShadow200 wants to merge 1 commit into from
Closed

Fix Image.Identify/IdentifyAsync byte array/file overloads still referring to a stream argument in documentation #2207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions src/ImageSharp/Image.FromBytes.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public static IImageFormat DetectFormat(Configuration configuration, byte[] data
}

/// <summary>
/// Reads the raw image information from the specified stream without fully decoding it.
/// Reads the raw image information from the given encoded byte array without fully decoding it.
Copy link
Member

@dlemstra dlemstra Aug 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we also using encoded in other comments?

Copy link
Author

@UnknownShadow200 UnknownShadow200 Aug 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For byte arrays, IdentifyFormat doesn't call them encoded in <summary> but Load does, so I went with the latter for consistency

Although the <summary> for streams/files doesn't mention encoded at all, so I can remove encoded from <summary> for byte arrays if preferable

/// </summary>
/// <param name="data">The byte array containing encoded image data to read the header from.</param>
/// <exception cref="ArgumentNullException">The data is null.</exception>
Expand All @@ -52,7 +52,7 @@ public static IImageFormat DetectFormat(Configuration configuration, byte[] data
public static IImageInfo Identify(byte[] data) => Identify(data, out IImageFormat _);

/// <summary>
/// Reads the raw image information from the specified stream without fully decoding it.
/// Reads the raw image information from the given encoded byte array without fully decoding it.
/// </summary>
/// <param name="data">The byte array containing encoded image data to read the header from.</param>
/// <param name="format">The format type of the decoded image.</param>
Expand All @@ -64,7 +64,7 @@ public static IImageFormat DetectFormat(Configuration configuration, byte[] data
public static IImageInfo Identify(byte[] data, out IImageFormat format) => Identify(Configuration.Default, data, out format);

/// <summary>
/// Reads the raw image information from the specified stream without fully decoding it.
/// Reads the raw image information from the given encoded byte array without fully decoding it.
/// </summary>
/// <param name="configuration">The configuration.</param>
/// <param name="data">The byte array containing encoded image data to read the header from.</param>
Expand Down
14 changes: 7 additions & 7 deletions src/ImageSharp/Image.FromFile.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public static IImageFormat DetectFormat(Configuration configuration, string file
}

/// <summary>
/// Reads the raw image information from the specified stream without fully decoding it.
/// Reads the raw image information from the given file without fully decoding it.
/// </summary>
/// <param name="filePath">The image file to open and to read the header from.</param>
/// <returns>
Expand All @@ -51,7 +51,7 @@ public static IImageInfo Identify(string filePath)
=> Identify(filePath, out IImageFormat _);

/// <summary>
/// Reads the raw image information from the specified stream without fully decoding it.
/// Reads the raw image information from the given file without fully decoding it.
/// </summary>
/// <param name="filePath">The image file to open and to read the header from.</param>
/// <param name="format">The format type of the decoded image.</param>
Expand All @@ -62,7 +62,7 @@ public static IImageInfo Identify(string filePath, out IImageFormat format)
=> Identify(Configuration.Default, filePath, out format);

/// <summary>
/// Reads the raw image information from the specified stream without fully decoding it.
/// Reads the raw image information from the given file without fully decoding it.
/// </summary>
/// <param name="configuration">The configuration.</param>
/// <param name="filePath">The image file to open and to read the header from.</param>
Expand All @@ -81,7 +81,7 @@ public static IImageInfo Identify(Configuration configuration, string filePath,
}

/// <summary>
/// Reads the raw image information from the specified stream without fully decoding it.
/// Reads the raw image information from the given file without fully decoding it.
/// </summary>
/// <param name="filePath">The image file to open and to read the header from.</param>
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
Expand All @@ -94,7 +94,7 @@ public static Task<IImageInfo> IdentifyAsync(string filePath, CancellationToken
=> IdentifyAsync(Configuration.Default, filePath, cancellationToken);

/// <summary>
/// Reads the raw image information from the specified stream without fully decoding it.
/// Reads the raw image information from the given file without fully decoding it.
/// </summary>
/// <param name="configuration">The configuration.</param>
/// <param name="filePath">The image file to open and to read the header from.</param>
Expand All @@ -115,7 +115,7 @@ public static async Task<IImageInfo> IdentifyAsync(
}

/// <summary>
/// Reads the raw image information from the specified stream without fully decoding it.
/// Reads the raw image information from the given file without fully decoding it.
/// </summary>
/// <param name="filePath">The image file to open and to read the header from.</param>
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
Expand All @@ -130,7 +130,7 @@ public static async Task<IImageInfo> IdentifyAsync(
=> IdentifyWithFormatAsync(Configuration.Default, filePath, cancellationToken);

/// <summary>
/// Reads the raw image information from the specified stream without fully decoding it.
/// Reads the raw image information from the given file without fully decoding it.
/// </summary>
/// <param name="configuration">The configuration.</param>
/// <param name="filePath">The image file to open and to read the header from.</param>
Expand Down