diff --git a/ImageSharp.sln.DotSettings b/ImageSharp.sln.DotSettings index 1839bf2f8..435aad73b 100644 --- a/ImageSharp.sln.DotSettings +++ b/ImageSharp.sln.DotSettings @@ -38,10 +38,15 @@ NEXT_LINE_SHIFTED_2 1 1 + False + False False + NEVER False False + NEVER False + ALWAYS False True ON_SINGLE_LINE @@ -370,8 +375,13 @@ <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> <Policy Inspect="True" Prefix="T" Suffix="" Style="AaBb" /> <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> + True + True + True + True True True + True True True \ No newline at end of file diff --git a/src/ImageSharp/Formats/IImageInfoDetector.cs b/src/ImageSharp/Formats/IImageInfoDetector.cs index 37bc0866f..b7769e895 100644 --- a/src/ImageSharp/Formats/IImageInfoDetector.cs +++ b/src/ImageSharp/Formats/IImageInfoDetector.cs @@ -6,7 +6,7 @@ using System.IO; namespace SixLabors.ImageSharp.Formats { /// - /// Used for detecting the raw image information without decoding it. + /// Encapsulates methods used for detecting the raw image information without fully decoding it. /// public interface IImageInfoDetector { diff --git a/src/ImageSharp/Formats/Jpeg/GolangPort/OrigJpegDecoderCore.cs b/src/ImageSharp/Formats/Jpeg/GolangPort/OrigJpegDecoderCore.cs index d788b65c4..cdc2a9197 100644 --- a/src/ImageSharp/Formats/Jpeg/GolangPort/OrigJpegDecoderCore.cs +++ b/src/ImageSharp/Formats/Jpeg/GolangPort/OrigJpegDecoderCore.cs @@ -204,6 +204,7 @@ namespace SixLabors.ImageSharp.Formats.Jpeg.GolangPort public IImageInfo Identify(Stream stream) { this.ParseStream(stream, true); + return new ImageInfo(new PixelTypeInfo(this.BitsPerPixel), this.ImageWidth, this.ImageHeight, this.MetaData); } diff --git a/src/ImageSharp/Formats/PixelTypeInfo.cs b/src/ImageSharp/Formats/PixelTypeInfo.cs index cdb6db8d9..ed21b91bf 100644 --- a/src/ImageSharp/Formats/PixelTypeInfo.cs +++ b/src/ImageSharp/Formats/PixelTypeInfo.cs @@ -1,7 +1,10 @@ -namespace SixLabors.ImageSharp.Formats +// Copyright (c) Six Labors and contributors. +// Licensed under the Apache License, Version 2.0. + +namespace SixLabors.ImageSharp.Formats { /// - /// Stores the raw image pixel type information. + /// Contains information about the pixels that make up an images visual data. /// public class PixelTypeInfo { diff --git a/src/ImageSharp/Formats/Png/PngDecoderCore.cs b/src/ImageSharp/Formats/Png/PngDecoderCore.cs index 5c9b753e5..5cdf80289 100644 --- a/src/ImageSharp/Formats/Png/PngDecoderCore.cs +++ b/src/ImageSharp/Formats/Png/PngDecoderCore.cs @@ -332,10 +332,10 @@ namespace SixLabors.ImageSharp.Formats.Png if (this.header == null) { - throw new ImageFormatException("PNG Image hasn't header chunk"); + throw new ImageFormatException("PNG Image does not contain a header chunk"); } - return new ImageInfo(new PixelTypeInfo(this.CalculateBitsPerPixel()), this.header.Width, this.header.Height, metadata); + return new ImageInfo(new PixelTypeInfo(this.CalculateBitsPerPixel()), this.header.Width, this.header.Height, metadata); } /// diff --git a/src/ImageSharp/Image/IImage.cs b/src/ImageSharp/Image/IImage.cs index afd00105e..7355dc1fe 100644 --- a/src/ImageSharp/Image/IImage.cs +++ b/src/ImageSharp/Image/IImage.cs @@ -1,7 +1,10 @@ -namespace SixLabors.ImageSharp +// Copyright (c) Six Labors and contributors. +// Licensed under the Apache License, Version 2.0. + +namespace SixLabors.ImageSharp { /// - /// Represents the base image abstraction. + /// Encapsulates the properties and methods that describe an image. /// public interface IImage : IImageInfo { diff --git a/src/ImageSharp/Image/IImageInfo.cs b/src/ImageSharp/Image/IImageInfo.cs index b8dd59cc7..25d5ec7ca 100644 --- a/src/ImageSharp/Image/IImageInfo.cs +++ b/src/ImageSharp/Image/IImageInfo.cs @@ -1,15 +1,19 @@ -using SixLabors.ImageSharp.Formats; +// Copyright (c) Six Labors and contributors. +// Licensed under the Apache License, Version 2.0. + +using SixLabors.ImageSharp.Formats; using SixLabors.ImageSharp.MetaData; namespace SixLabors.ImageSharp { /// - /// Represents raw image information. + /// Encapsulates properties that descibe basic image information including dimensions, pixel type information + /// and additional metadata /// public interface IImageInfo { /// - /// Gets the raw image pixel type information. + /// Gets information about the image pixels. /// PixelTypeInfo PixelType { get; } @@ -24,7 +28,7 @@ namespace SixLabors.ImageSharp int Height { get; } /// - /// Gets the meta data of the image. + /// Gets the metadata of the image. /// ImageMetaData MetaData { get; } } diff --git a/src/ImageSharp/Image/Image.Decode.cs b/src/ImageSharp/Image/Image.Decode.cs index 6af61f9f4..ef00ff15f 100644 --- a/src/ImageSharp/Image/Image.Decode.cs +++ b/src/ImageSharp/Image/Image.Decode.cs @@ -81,7 +81,7 @@ namespace SixLabors.ImageSharp } /// - /// Reads the image base information. + /// Reads the raw image information from the specified stream. /// /// The stream. /// the configuration. diff --git a/src/ImageSharp/Image/Image.FromStream.cs b/src/ImageSharp/Image/Image.FromStream.cs index 680e15aa7..62668dd02 100644 --- a/src/ImageSharp/Image/Image.FromStream.cs +++ b/src/ImageSharp/Image/Image.FromStream.cs @@ -52,15 +52,15 @@ namespace SixLabors.ImageSharp } /// - /// By reading the header on the provided stream this reads the raw image information. + /// Reads the raw image information from the specified stream without fully decoding it. /// /// The configuration. - /// The image stream to read the header from. + /// The image stream to read the information from. /// /// Thrown if the stream is not readable nor seekable. /// /// - /// The or null if suitable info detector not found. + /// The or null if suitable info detector is not found. /// public static IImageInfo Identify(Configuration config, Stream stream) { diff --git a/src/ImageSharp/Image/ImageInfo.cs b/src/ImageSharp/Image/ImageInfo.cs index a315ee0ed..6f894cb59 100644 --- a/src/ImageSharp/Image/ImageInfo.cs +++ b/src/ImageSharp/Image/ImageInfo.cs @@ -1,17 +1,20 @@ -using SixLabors.ImageSharp.Formats; +// Copyright (c) Six Labors and contributors. +// Licensed under the Apache License, Version 2.0. + +using SixLabors.ImageSharp.Formats; using SixLabors.ImageSharp.MetaData; namespace SixLabors.ImageSharp { /// - /// Stores the raw image information. + /// Contains information about the image including dimensions, pixel type information and additional metadata /// internal sealed class ImageInfo : IImageInfo { /// /// Initializes a new instance of the class. /// - /// The raw image pixel type information. + /// The image pixel type information. /// The width of the image in pixels. /// The height of the image in pixels. /// The images metadata.