Skip to content

Commit 34cdbee

Browse files
Merge pull request #2426 from hey-red/main
Fix incorrect comments
2 parents 3cafdcb + 764452a commit 34cdbee

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

src/ImageSharp/Image.FromFile.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public static async Task<IImageFormat> DetectFormatAsync(
8181
/// A return value indicates whether the operation succeeded.
8282
/// </summary>
8383
/// <param name="path">The image file to open and to read the header from.</param>
84-
/// <returns><see langword="true"/> if the information can be read; otherwise, <see langword="false"/></returns>
84+
/// <returns>The <see cref="ImageInfo"/>.</returns>
8585
/// <exception cref="ArgumentNullException">The path is null.</exception>
8686
/// <exception cref="NotSupportedException">The file stream is not readable or the image format is not supported.</exception>
8787
/// <exception cref="InvalidImageContentException">The encoded image contains invalid content.</exception>

src/ImageSharp/Image.FromStream.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public static IImageFormat DetectFormat(Stream stream)
2929
/// </summary>
3030
/// <param name="options">The general decoder options.</param>
3131
/// <param name="stream">The image stream to read the header from.</param>
32-
/// <returns><see langword="true"/> if a match is found; otherwise, <see langword="false"/></returns>
32+
/// <returns>The <see cref="IImageFormat"/>.</returns>
3333
/// <exception cref="ArgumentNullException">The options are null.</exception>
3434
/// <exception cref="ArgumentNullException">The stream is null.</exception>
3535
/// <exception cref="NotSupportedException">The stream is not readable or the image format is not supported.</exception>
@@ -79,7 +79,7 @@ public static Task<IImageFormat> DetectFormatAsync(
7979
/// Reads the raw image information from the specified stream without fully decoding it.
8080
/// </summary>
8181
/// <param name="stream">The image stream to read the header from.</param>
82-
/// <returns><see langword="true"/> if the information can be read; otherwise, <see langword="false"/></returns>
82+
/// <returns>The <see cref="ImageInfo"/>.</returns>
8383
/// <exception cref="ArgumentNullException">The stream is null.</exception>
8484
/// <exception cref="NotSupportedException">The stream is not readable or the image format is not supported.</exception>
8585
/// <exception cref="InvalidImageContentException">The encoded image contains invalid content.</exception>

0 commit comments

Comments
 (0)