Browse Source

Add moar xml doc details.

af/merge-core
James Jackson-South 8 years ago
parent
commit
0e11ffa3d9
  1. 5
      src/ImageSharp/Processing/Quantization/OctreeQuantizer.cs
  2. 6
      src/ImageSharp/Processing/Quantization/PaletteQuantizer.cs
  3. 6
      src/ImageSharp/Processing/Quantization/WuQuantizer.cs

5
src/ImageSharp/Processing/Quantization/OctreeQuantizer.cs

@ -11,6 +11,9 @@ namespace SixLabors.ImageSharp.Processing.Quantization
/// <summary> /// <summary>
/// Allows the quantization of images pixels using Octrees. /// Allows the quantization of images pixels using Octrees.
/// <see href="http://msdn.microsoft.com/en-us/library/aa479306.aspx"/> /// <see href="http://msdn.microsoft.com/en-us/library/aa479306.aspx"/>
/// <para>
/// By default the quantizer uses <see cref="KnownDiffusers.FloydSteinberg"/> dithering and a color palette of a maximum length of <value>255</value>
/// </para>
/// </summary> /// </summary>
public class OctreeQuantizer : IQuantizer public class OctreeQuantizer : IQuantizer
{ {
@ -45,7 +48,7 @@ namespace SixLabors.ImageSharp.Processing.Quantization
/// </summary> /// </summary>
/// <param name="diffuser">The error diffusion algorithm, if any, to apply to the output image</param> /// <param name="diffuser">The error diffusion algorithm, if any, to apply to the output image</param>
public OctreeQuantizer(IErrorDiffuser diffuser) public OctreeQuantizer(IErrorDiffuser diffuser)
: this(diffuser, 255) : this(diffuser, 255)
{ {
} }

6
src/ImageSharp/Processing/Quantization/PaletteQuantizer.cs

@ -10,8 +10,10 @@ namespace SixLabors.ImageSharp.Processing.Quantization
{ {
/// <summary> /// <summary>
/// Allows the quantization of images pixels using web safe colors defined in the CSS Color Module Level 4. /// Allows the quantization of images pixels using web safe colors defined in the CSS Color Module Level 4.
/// <see href="http://msdn.microsoft.com/en-us/library/aa479306.aspx"/> /// <see href="http://msdn.microsoft.com/en-us/library/aa479306.aspx"/> Override this class to provide your own palette.
/// Override this class to provide your own palette. /// <para>
/// By default the quantizer uses <see cref="KnownDiffusers.FloydSteinberg"/> dithering and the <see cref="NamedColors{TPixel}.WebSafePalette"/>
/// </para>
/// </summary> /// </summary>
public class PaletteQuantizer : IQuantizer public class PaletteQuantizer : IQuantizer
{ {

6
src/ImageSharp/Processing/Quantization/WuQuantizer.cs

@ -9,8 +9,10 @@ using SixLabors.ImageSharp.Processing.Quantization.FrameQuantizers;
namespace SixLabors.ImageSharp.Processing.Quantization namespace SixLabors.ImageSharp.Processing.Quantization
{ {
/// <summary> /// <summary>
/// Allows the quantization of images pixels using Xiaolin Wu's Color Quantizer. /// Allows the quantization of images pixels using Xiaolin Wu's Color Quantizer <see href="http://www.ece.mcmaster.ca/~xwu/cq.c"/>
/// <see href="http://www.ece.mcmaster.ca/~xwu/cq.c"/> /// <para>
/// By default the quantizer uses <see cref="KnownDiffusers.FloydSteinberg"/> dithering and a color palette of a maximum length of <value>255</value>
/// </para>
/// </summary> /// </summary>
public class WuQuantizer : IQuantizer public class WuQuantizer : IQuantizer
{ {

Loading…
Cancel
Save