diff --git a/src/ImageSharp/IImageFrameCollection.cs b/src/ImageSharp/IImageFrameCollection.cs index c9232c7780..59c64a6af6 100644 --- a/src/ImageSharp/IImageFrameCollection.cs +++ b/src/ImageSharp/IImageFrameCollection.cs @@ -9,14 +9,14 @@ using SixLabors.ImageSharp.PixelFormats; namespace SixLabors.ImageSharp { /// - /// Encapsulates an imaged collection of frames. + /// Encapsulates a collection of instances that make up an . /// /// The type of the pixel. public interface IImageFrameCollection : IEnumerable> where TPixel : struct, IPixel { /// - /// Gets the count. + /// Gets the number of frames. /// int Count { get; } @@ -36,30 +36,31 @@ namespace SixLabors.ImageSharp ImageFrame this[int index] { get; } /// - /// Clones the the frame at and generates a new images with all the same metadata from the orgional but with only the single frame on it. + /// Creates an with only the frame at the specified index + /// with the same metadata as the original image. /// - /// The zero-based index at which item should be removed. - /// Cannot remove last frame. - /// The new with only the one frame on it. + /// The zero-based index of the frame to clone. + /// The new with the specified frame. Image CloneFrame(int index); /// - /// Removed the frame at and generates a new images with all the same metadata from the orgional but with only the single frame on it. + /// Removes the frame at the specified index and creates a new image with only the removed frame + /// with the same metadata as the original image. /// - /// The zero-based index at which item should be removed. + /// The zero-based index of the frame to export. /// Cannot remove last frame. - /// The new with only the one frame on it. + /// The new with the specified frame. Image ExportFrame(int index); /// - /// Remove the frame at and frees all freeable resources associated with it. + /// Removes the frame at the specified index and frees all freeable resources associated with it. /// - /// The zero-based index at which item should be removed. + /// The zero-based index of the frame to remove. /// Cannot remove last frame. void RemoveFrame(int index); /// - /// Creates a new and appends it appends it to the end of the collection. + /// Creates a new and appends it to the end of the collection. /// /// The new . ImageFrame CreateFrame(); @@ -67,48 +68,47 @@ namespace SixLabors.ImageSharp /// /// Clones the frame and appends the clone to the end of the collection. /// - /// The raw pixel data to generate from. + /// The raw pixel data to generate the from. /// The cloned . ImageFrame AddFrame(ImageFrame source); /// - /// Creates a new frame from the pixel data at the same dimensions at the current image and inserts the new frame - /// into the at the end of the collection. + /// Creates a new frame from the pixel data with the same dimensions as the other frames and inserts the + /// new frame at the end of the collection. /// - /// The raw pixel data to generate from. + /// The raw pixel data to generate the from. /// The new . ImageFrame AddFrame(TPixel[] source); /// - /// Clones and inserts the into the at the specified . + /// Clones and inserts the into the at the specified . /// - /// The zero-based index at which item should be inserted. - /// The to clone and insert into the . - /// Frame must have the same dimensions as the image - frame + /// The zero-based index to insert the frame at. + /// The to clone and insert into the . + /// Frame must have the same dimensions as the image. /// The cloned . ImageFrame InsertFrame(int index, ImageFrame source); /// - /// Moves a from the at the specified index to the other index. + /// Moves an from to . /// - /// The zero-based index of the item to move. - /// The zero-based index of the new index that should be inserted at. - /// Cannot remove last frame. + /// The zero-based index of the frame to move. + /// The index to move the frame to. void MoveFrame(int sourceIndex, int destinationIndex); /// - /// Determines the index of a specific in the . + /// Determines the index of a specific in the . /// - /// The to locate in the . + /// The to locate in the . /// The index of item if found in the list; otherwise, -1. int IndexOf(ImageFrame frame); /// - /// Determines whether the contains the . + /// Determines whether the contains the . /// /// The frame. /// - /// true if the the specified frame; otherwise, false. + /// true if the contains the specified frame; otherwise, false. /// bool Contains(ImageFrame frame); } diff --git a/src/ImageSharp/ImageFrameCollection.cs b/src/ImageSharp/ImageFrameCollection.cs index ef4f709597..a9225eec49 100644 --- a/src/ImageSharp/ImageFrameCollection.cs +++ b/src/ImageSharp/ImageFrameCollection.cs @@ -9,10 +9,7 @@ using SixLabors.ImageSharp.PixelFormats; namespace SixLabors.ImageSharp { - /// - /// Encapsulates a collection of frames that make up an image. - /// - /// The type of the pixel. + /// internal sealed class ImageFrameCollection : IImageFrameCollection where TPixel : struct, IPixel {