From 9c5798bb4b60626b7f9766820bb616059e366b4a Mon Sep 17 00:00:00 2001 From: JimBobSquarePants Date: Mon, 14 Aug 2017 11:13:11 +1000 Subject: [PATCH] Intellisense docs cleanup --- src/ImageSharp/ApplyProcessors.cs | 32 +++++++++---------- src/ImageSharp/Configuration.cs | 12 +++---- .../DefaultInternalImageProcessorContext.cs | 2 +- .../IImageProcessingContextFactory.cs | 8 ++--- .../IImageProcessingContext{TPixel}.cs | 2 +- src/ImageSharp/Processing/Delegate.cs | 8 ++--- .../Processors/CloningImageProcessor.cs | 2 +- 7 files changed, 33 insertions(+), 33 deletions(-) diff --git a/src/ImageSharp/ApplyProcessors.cs b/src/ImageSharp/ApplyProcessors.cs index e60cff2e0..a04c02a42 100644 --- a/src/ImageSharp/ApplyProcessors.cs +++ b/src/ImageSharp/ApplyProcessors.cs @@ -17,11 +17,11 @@ namespace ImageSharp public static partial class ImageExtensions { /// - /// Mutates the image by applying the image operation to it. + /// Mutates the source image by applying the image operation to it. /// /// The pixel format. - /// The image to rotate, flip, or both. - /// The operations to perform on the source. + /// The image to mutate. + /// The operation to perform on the source. public static void Mutate(this Image source, Action> operation) where TPixel : struct, IPixel { @@ -34,10 +34,10 @@ namespace ImageSharp } /// - /// Mutates the image by applying the operations to it. + /// Mutates the source image by applying the operations to it. /// /// The pixel format. - /// The image to rotate, flip, or both. + /// The image to mutate. /// The operations to perform on the source. public static void Mutate(this Image source, params IImageProcessor[] operations) where TPixel : struct, IPixel @@ -51,12 +51,12 @@ namespace ImageSharp } /// - /// Clones the current image mutating the clone by applying the operation to it. + /// Creates a deep clone of the current image. The clone is then mutated by the given operation. /// /// The pixel format. - /// The image to rotate, flip, or both. - /// The operations to perform on the source. - /// Anew Image which has teh data from the but with the applied. + /// The image to clone. + /// The operation to perform on the clone. + /// The new public static Image Clone(this Image source, Action> operation) where TPixel : struct, IPixel { @@ -69,12 +69,12 @@ namespace ImageSharp } /// - /// Clones the current image mutating the clone by applying the operations to it. + /// Creates a deep clone of the current image. The clone is then mutated by the given operations. /// /// The pixel format. - /// The image to rotate, flip, or both. - /// The operations to perform on the source. - /// Anew Image which has teh data from the but with the applied. + /// The image to clone. + /// The operations to perform on the clone. + /// The new public static Image Clone(this Image source, params IImageProcessor[] operations) where TPixel : struct, IPixel { @@ -87,12 +87,12 @@ namespace ImageSharp } /// - /// Applies all the ImageProcessors agains the operation + /// Applies the given collection against the context /// /// The pixel format. - /// The image to rotate, flip, or both. + /// The image processing context. /// The operations to perform on the source. - /// returns the current operations class to allow chaining of operations. + /// The to allow chaining of operations. public static IImageProcessingContext ApplyProcessors(this IImageProcessingContext source, params IImageProcessor[] operations) where TPixel : struct, IPixel { diff --git a/src/ImageSharp/Configuration.cs b/src/ImageSharp/Configuration.cs index 71f6bf412..a34544ab0 100644 --- a/src/ImageSharp/Configuration.cs +++ b/src/ImageSharp/Configuration.cs @@ -109,9 +109,9 @@ namespace ImageSharp #endif /// - /// Gets or sets the image operations providers. + /// Gets or sets the image operations provider factory. /// - internal IImageProcessingContextFactory ImageOperationsProvider { get; set; } = new DefaultImageOperationsProvider(); + internal IImageProcessingContextFactory ImageOperationsProvider { get; set; } = new DefaultImageOperationsProviderFactory(); /// /// Registers a new format provider. @@ -126,7 +126,7 @@ namespace ImageSharp /// /// Registers a new format provider. /// - /// The format to register as a well know format. + /// The format to register as a known format. public void AddImageFormat(IImageFormat format) { Guard.NotNull(format, nameof(format)); @@ -136,10 +136,10 @@ namespace ImageSharp } /// - /// For the specified file extensions type find the e . + /// For the specified file extensions type find the . /// /// The extension to discover - /// The if found otherwise null + /// The if found; otherwise null public IImageFormat FindFormatByFileExtensions(string extension) { return this.imageFormats.FirstOrDefault(x => x.FileExtensions.Contains(extension, StringComparer.OrdinalIgnoreCase)); @@ -149,7 +149,7 @@ namespace ImageSharp /// For the specified mime type find the . /// /// The mime-type to discover - /// The if found otherwise null + /// The if found; otherwise null public IImageFormat FindFormatByMimeType(string mimeType) { return this.imageFormats.FirstOrDefault(x => x.MimeTypes.Contains(mimeType, StringComparer.OrdinalIgnoreCase)); diff --git a/src/ImageSharp/DefaultInternalImageProcessorContext.cs b/src/ImageSharp/DefaultInternalImageProcessorContext.cs index 6165fbf00..4b919db14 100644 --- a/src/ImageSharp/DefaultInternalImageProcessorContext.cs +++ b/src/ImageSharp/DefaultInternalImageProcessorContext.cs @@ -40,7 +40,7 @@ namespace ImageSharp { if (!this.mutate && this.destination == null) { - // Ensure we have cloned it if we are not mutating as we might have failed to register any Processors + // Ensure we have cloned it if we are not mutating as we might have failed to register any processors this.destination = this.source.Clone(); } diff --git a/src/ImageSharp/IImageProcessingContextFactory.cs b/src/ImageSharp/IImageProcessingContextFactory.cs index 394f198bf..08c536a60 100644 --- a/src/ImageSharp/IImageProcessingContextFactory.cs +++ b/src/ImageSharp/IImageProcessingContextFactory.cs @@ -13,20 +13,20 @@ namespace ImageSharp internal interface IImageProcessingContextFactory { /// - /// Called during Mutate operations to generate the image operations provider. + /// Called during mutate operations to generate the image operations provider. /// /// The pixel format /// The source image. - /// A flag to determin with the image operations is allowed to mutate the source image or not. + /// A flag to determine whether image operations are allowed to mutate the source image. /// A new IImageOPeration IInternalImageProcessingContext CreateImageProcessingContext(Image source, bool mutate) where TPixel : struct, IPixel; } /// - /// The default implmentation of IImageOperationsProvider + /// The default implmentation of /// - internal class DefaultImageOperationsProvider : IImageProcessingContextFactory + internal class DefaultImageOperationsProviderFactory : IImageProcessingContextFactory { /// public IInternalImageProcessingContext CreateImageProcessingContext(Image source, bool mutate) diff --git a/src/ImageSharp/IImageProcessingContext{TPixel}.cs b/src/ImageSharp/IImageProcessingContext{TPixel}.cs index a3f24186b..6aa2b799f 100644 --- a/src/ImageSharp/IImageProcessingContext{TPixel}.cs +++ b/src/ImageSharp/IImageProcessingContext{TPixel}.cs @@ -10,7 +10,7 @@ namespace ImageSharp using SixLabors.Primitives; /// - /// An interface to queue up image operations. + /// An interface to queue up image operations to apply to an image. /// /// The pixel format public interface IImageProcessingContext diff --git a/src/ImageSharp/Processing/Delegate.cs b/src/ImageSharp/Processing/Delegate.cs index 76f968dec..5edb900df 100644 --- a/src/ImageSharp/Processing/Delegate.cs +++ b/src/ImageSharp/Processing/Delegate.cs @@ -17,12 +17,12 @@ namespace ImageSharp public static partial class ImageExtensions { /// - /// Queues up an operation that provides access to the mutatable image. + /// Applies the given operation to the mutable image. /// /// The pixel format. - /// The image to rotate, flip, or both. - /// The operations to perform on the source. - /// returns the current operations class to allow chaining of operations. + /// The image to mutate. + /// The operation to perform on the source. + /// The to allow chaining of operations. public static IImageProcessingContext Apply(this IImageProcessingContext source, Action> operation) where TPixel : struct, IPixel => source.ApplyProcessor(new DelegateProcessor(operation)); diff --git a/src/ImageSharp/Processing/Processors/CloningImageProcessor.cs b/src/ImageSharp/Processing/Processors/CloningImageProcessor.cs index cf84462c5..5db2d0865 100644 --- a/src/ImageSharp/Processing/Processors/CloningImageProcessor.cs +++ b/src/ImageSharp/Processing/Processors/CloningImageProcessor.cs @@ -94,7 +94,7 @@ namespace ImageSharp.Processing } /// - /// Generates the clone of the source image that operatinos should be applied to. + /// Generates a deep clone of the source image that operatinos should be applied to. /// /// The source image. Cannot be null. /// The source rectangle.