Skip to content

Commit

Permalink
Improved docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
dlemstra committed Nov 13, 2023
1 parent 17462e8 commit e023b58
Show file tree
Hide file tree
Showing 18 changed files with 75 additions and 75 deletions.
4 changes: 2 additions & 2 deletions src/Magick.NET.Core/Enums/CompressionMethod.cs
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public enum CompressionMethod
JPEG,

/// <summary>
/// LosslessJPEG.
/// Lossless JPEG.
/// </summary>
LosslessJPEG,

Expand All @@ -89,7 +89,7 @@ public enum CompressionMethod
LZW,

/// <summary>
/// NoCompression.
/// No compression.
/// </summary>
NoCompression,

Expand Down
20 changes: 10 additions & 10 deletions src/Magick.NET.Core/Enums/DistortMethod.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ public enum DistortMethod
Affine,

/// <summary>
/// AffineProjection.
/// Affine projection.
/// </summary>
AffineProjection,

/// <summary>
/// ScaleRotateTranslate.
/// Scale rotate translate.
/// </summary>
ScaleRotateTranslate,

Expand All @@ -34,17 +34,17 @@ public enum DistortMethod
Perspective,

/// <summary>
/// PerspectiveProjection.
/// Perspective projection.
/// </summary>
PerspectiveProjection,

/// <summary>
/// BilinearForward.
/// Bilinear forward.
/// </summary>
BilinearForward,

/// <summary>
/// BilinearReverse.
/// Bilinear reverse.
/// </summary>
BilinearReverse,

Expand All @@ -64,17 +64,17 @@ public enum DistortMethod
Polar,

/// <summary>
/// DePolar.
/// De-polar.
/// </summary>
DePolar,

/// <summary>
/// Cylinder2Plane.
/// Cylinder 2 plane.
/// </summary>
Cylinder2Plane,

/// <summary>
/// Plane2Cylinder.
/// Plane 2 cylinder.
/// </summary>
Plane2Cylinder,

Expand All @@ -84,7 +84,7 @@ public enum DistortMethod
Barrel,

/// <summary>
/// BarrelInverse.
/// Barrel inverse.
/// </summary>
BarrelInverse,

Expand All @@ -104,7 +104,7 @@ public enum DistortMethod
Sentinel,

/// <summary>
/// RigidAffine.
/// Rigid affine.
/// </summary>
RigidAffine,
}
4 changes: 2 additions & 2 deletions src/Magick.NET.Core/Enums/Endian.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ public enum Endian
Undefined,

/// <summary>
/// LSB.
/// Least significant bit, byte 0 is least significant.
/// </summary>
LSB,

/// <summary>
/// MSB.
/// Most significant bit, byte 0 is most significant.
/// </summary>
MSB,
}
20 changes: 10 additions & 10 deletions src/Magick.NET.Core/Enums/ErrorMetric.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,52 +24,52 @@ public enum ErrorMetric
Fuzz,

/// <summary>
/// MeanAbsolute.
/// Mean absolute.
/// </summary>
MeanAbsolute,

/// <summary>
/// MeanErrorPerPixel.
/// Mean error per pixel.
/// </summary>
MeanErrorPerPixel,

/// <summary>
/// MeanSquared.
/// Mean squared.
/// </summary>
MeanSquared,

/// <summary>
/// NormalizedCrossCorrelation.
/// Normalized cross correlation.
/// </summary>
NormalizedCrossCorrelation,

/// <summary>
/// PeakAbsolute.
/// Peak absolute.
/// </summary>
PeakAbsolute,

/// <summary>
/// PeakSignalToNoiseRatio.
/// Peak signal to noise ratio.
/// </summary>
PeakSignalToNoiseRatio,

/// <summary>
/// PerceptualHash.
/// Perceptual hash.
/// </summary>
PerceptualHash,

/// <summary>
/// RootMeanSquared.
/// Root mean squared.
/// </summary>
RootMeanSquared,

/// <summary>
/// StructuralSimilarity.
/// Structural similarity.
/// </summary>
StructuralSimilarity,

/// <summary>
/// StructuralDissimilarity.
/// Structural dissimilarity.
/// </summary>
StructuralDissimilarity,
}
26 changes: 13 additions & 13 deletions src/Magick.NET.Core/Enums/EvaluateOperator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public enum EvaluateOperator
Add,

/// <summary>
/// AddModulus.
/// Add modulus.
/// </summary>
AddModulus,

Expand All @@ -49,22 +49,22 @@ public enum EvaluateOperator
Exponential,

/// <summary>
/// GaussianNoise.
/// Gaussian noise.
/// </summary>
GaussianNoise,

/// <summary>
/// ImpulseNoise.
/// Impulse noise.
/// </summary>
ImpulseNoise,

/// <summary>
/// LaplacianNoise.
/// Laplacian noise.
/// </summary>
LaplacianNoise,

/// <summary>
/// LeftShift.
/// Left shift.
/// </summary>
LeftShift,

Expand Down Expand Up @@ -94,7 +94,7 @@ public enum EvaluateOperator
Min,

/// <summary>
/// MultiplicativeNoise.
/// Multiplicative noise.
/// </summary>
MultiplicativeNoise,

Expand All @@ -109,7 +109,7 @@ public enum EvaluateOperator
Or,

/// <summary>
/// PoissonNoise.
/// Poisson noise.
/// </summary>
PoissonNoise,

Expand All @@ -119,12 +119,12 @@ public enum EvaluateOperator
Pow,

/// <summary>
/// RightShift.
/// Right shift.
/// </summary>
RightShift,

/// <summary>
/// RootMeanSquare.
/// Root mean square.
/// </summary>
RootMeanSquare,

Expand All @@ -149,7 +149,7 @@ public enum EvaluateOperator
Sum,

/// <summary>
/// ThresholdBlack.
/// Threshold black.
/// </summary>
ThresholdBlack,

Expand All @@ -159,12 +159,12 @@ public enum EvaluateOperator
Threshold,

/// <summary>
/// ThresholdWhite.
/// Threshold white.
/// </summary>
ThresholdWhite,

/// <summary>
/// UniformNoise.
/// Uniform noise.
/// </summary>
UniformNoise,

Expand All @@ -174,7 +174,7 @@ public enum EvaluateOperator
Xor,

/// <summary>
/// InverseLog.
/// Inverse log.
/// </summary>
InverseLog,
}
14 changes: 7 additions & 7 deletions src/Magick.NET.Core/Enums/FilterType.cs
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public enum FilterType
Sinc,

/// <summary>
/// SincFast.
/// Sinc fast.
/// </summary>
SincFast,

Expand Down Expand Up @@ -124,17 +124,17 @@ public enum FilterType
Lanczos,

/// <summary>
/// LanczosSharp.
/// Lanczos sharp.
/// </summary>
LanczosSharp,

/// <summary>
/// Lanczos2.
/// Lanczos 2.
/// </summary>
Lanczos2,

/// <summary>
/// Lanczos2Sharp.
/// Lanczos 2 sharp.
/// </summary>
Lanczos2Sharp,

Expand All @@ -144,7 +144,7 @@ public enum FilterType
Robidoux,

/// <summary>
/// RobidouxSharp.
/// Robidoux sharp.
/// </summary>
RobidouxSharp,

Expand All @@ -159,12 +159,12 @@ public enum FilterType
Spline,

/// <summary>
/// LanczosRadius.
/// Lanczos radius.
/// </summary>
LanczosRadius,

/// <summary>
/// CubicSpline.
/// Cubic spline.
/// </summary>
CubicSpline,
}
2 changes: 1 addition & 1 deletion src/Magick.NET.Core/Enums/Interlace.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public enum Interlace
Undefined,

/// <summary>
/// NoInterlace.
/// No interlacing.
/// </summary>
NoInterlace,

Expand Down
12 changes: 6 additions & 6 deletions src/Magick.NET.Core/Enums/Kernel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public enum Kernel
Sobel,

/// <summary>
/// FreiChen.
/// Frei chen.
/// </summary>
FreiChen,

Expand Down Expand Up @@ -144,12 +144,12 @@ public enum Kernel
Diagonals,

/// <summary>
/// LineEnds.
/// Line ends.
/// </summary>
LineEnds,

/// <summary>
/// LineJunctions.
/// Line junctions.
/// </summary>
LineJunctions,

Expand All @@ -159,12 +159,12 @@ public enum Kernel
Ridges,

/// <summary>
/// ConvexHull.
/// Convex hull.
/// </summary>
ConvexHull,

/// <summary>
/// ThinSE.
/// Thin SE.
/// </summary>
ThinSE,

Expand Down Expand Up @@ -194,7 +194,7 @@ public enum Kernel
Euclidean,

/// <summary>
/// UserDefined.
/// User defined.
/// </summary>
UserDefined,
}
2 changes: 1 addition & 1 deletion src/Magick.NET.Core/Enums/LogEvents.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
namespace ImageMagick;

/// <summary>
/// Specifies log events.
/// Specifies log event types.
/// </summary>
[Flags]
public enum LogEvents
Expand Down
Loading

0 comments on commit e023b58

Please sign in to comment.