diff --git a/Source/DotSpatial.Data/Argb.cs b/Source/DotSpatial.Data/Argb.cs index a7d720bd0..32dcd0079 100644 --- a/Source/DotSpatial.Data/Argb.cs +++ b/Source/DotSpatial.Data/Argb.cs @@ -3,7 +3,7 @@ namespace DotSpatial.Data { /// - /// Tiny structure for storing A,R,G,B components of Color + /// Tiny structure for storing A,R,G,B components of Color. /// public struct Argb { @@ -16,12 +16,26 @@ public struct Argb #endregion + /// + /// Creates a new Argb object from the given values. If the values are bigger than 255 they are changed to 255. If the values are smaller than 0 they are changed to 0. + /// + /// The a part of a color. + /// The r part of a color. + /// The g part of a color. + /// The b part of a color. public Argb(int a, int r, int g, int b) : this(ByteRange(a), ByteRange(r), ByteRange(g), ByteRange(b)) { } + /// + /// Creates a new Argb object from the given values. + /// + /// The a part of a color. + /// The r part of a color. + /// The g part of a color. + /// The b part of a color. public Argb(byte a, byte r, byte g, byte b) { _a = a; @@ -30,32 +44,44 @@ public Argb(byte a, byte r, byte g, byte b) _b = b; } + /// + /// The A part of this Argb object. + /// public byte A { get { return _a; } } + /// + /// The B part of this Argb object. + /// public byte B { get { return _b; } } + /// + /// The G part of this Argb object. + /// public byte G { get { return _g; } } + /// + /// The R part of this Argb object. + /// public byte R { get { return _r; } } /// - /// Returns an integer that ranges from 0 to 255. If value is larger than 255, the value will be equal to 255. - /// If the value is smaller than 255, it will be equal to 255. + /// Returns an byte that corresponds to the given value. If value is larger than 255, the value will be equal to 255. + /// If the value is smaller than 0, it will be equal to 0. /// - /// A Double value to convert. - /// An integer ranging from 0 to 255 + /// An integer value to convert. + /// A byte that corresponds to the integer ranging from 0 to 255. public static byte ByteRange(int value) { if (value > 255) return 255; @@ -63,11 +89,20 @@ public static byte ByteRange(int value) return (byte)value; } + /// + /// Converts this Argb to Color. + /// + /// Color build from the Argb values. public Color ToColor() { return Color.FromArgb(A, R, G, B); } + /// + /// Converts the given Color to Argb. + /// + /// color that gets converted. + /// Argb object that contains the color values. public static Argb FromColor(Color color) { return new Argb(color.A, color.R, color.G, color.B); diff --git a/Source/DotSpatial.NTSExtension/EnvelopeExt.cs b/Source/DotSpatial.NTSExtension/EnvelopeExt.cs index 8c4d5907a..b0d9c3526 100644 --- a/Source/DotSpatial.NTSExtension/EnvelopeExt.cs +++ b/Source/DotSpatial.NTSExtension/EnvelopeExt.cs @@ -4,8 +4,17 @@ namespace DotSpatial.NTSExtension { + /// + /// This contains extension methods for GeoApi.Geometries.Envelope. + /// public static class EnvelopeExt { + /// + /// Initializes the envelopes Minimum.Z with the smaller of the two given z values and the Maximum.Z with the bigger of the two given z values. + /// + /// Envelope, whos Minimum and Maximum.Z should be initialized. + /// First z value. + /// Second z value. public static void InitZ(this Envelope envelope, double z1, double z2) { if (z1 < z2) @@ -20,6 +29,12 @@ public static void InitZ(this Envelope envelope, double z1, double z2) } } + /// + /// Initializes the envelopes Minimum.M with the smaller of the two given m values and the Maximum.M with the bigger of the two given m values. + /// + /// Envelope, whos Minimum and Maximum.M should be initialized. + /// First m value. + /// Second m value. public static void InitM(this Envelope envelope, double m1, double m2) { if (m1 < m2) @@ -34,6 +49,11 @@ public static void InitM(this Envelope envelope, double m1, double m2) } } + /// + /// Checks whether the given Envelope has M values. + /// + /// Envelope that gets checked. + /// False if either envelope.Minimum.M or envelope.Maximum.M is not a number or Minimum.M is bigger than Maximum.M. public static bool HasM(this Envelope envelope) { if (double.IsNaN(envelope.Minimum.M) || double.IsNaN(envelope.Maximum.M)) @@ -41,6 +61,11 @@ public static bool HasM(this Envelope envelope) return envelope.Minimum.M <= envelope.Maximum.M; } + /// + /// Checks whether the given Envelope has Z values. + /// + /// Envelope that gets checked. + /// False if either envelope.Minimum.Z or envelope.Maximum.Z is not a number or Minimum.Z is bigger than Maximum.Z. public static bool HasZ(this Envelope envelope) { if (double.IsNaN(envelope.Minimum.Z) || double.IsNaN(envelope.Maximum.Z)) diff --git a/Source/DotSpatial.NTSExtension/GeometryExt.cs b/Source/DotSpatial.NTSExtension/GeometryExt.cs index 37cc86044..abc0fe353 100644 --- a/Source/DotSpatial.NTSExtension/GeometryExt.cs +++ b/Source/DotSpatial.NTSExtension/GeometryExt.cs @@ -3,6 +3,9 @@ namespace DotSpatial.NTSExtension { + /// + /// Contains extension methods for GeoAPI.Geometries.IGeometry. + /// public static class GeometryExt { @@ -50,6 +53,7 @@ public static void Rotate(this IGeometry self, Coordinate origin, double radAngl break; } } + /// /// Rotates the given coordinate by the given radian angle around the origin. /// diff --git a/Source/DotSpatial.NTSExtension/LineStringExt.cs b/Source/DotSpatial.NTSExtension/LineStringExt.cs index 38042c6da..7993f5508 100644 --- a/Source/DotSpatial.NTSExtension/LineStringExt.cs +++ b/Source/DotSpatial.NTSExtension/LineStringExt.cs @@ -4,12 +4,16 @@ namespace DotSpatial.NTSExtension { + /// + /// Contains extension methodes for GeoAPI.Geomtetries.ILineString. + /// public static class LineStringExt { /// /// Gets the value of the angle between the StartPoint and the EndPoint in Radian. - /// + /// + /// The ILineString, whose angle is returned. /// added by JLeiss public static double RadAngle(this ILineString self) { @@ -28,7 +32,8 @@ public static double RadAngle(this ILineString self) /// /// Given the specified test point, this checks each segment, and will /// return the closest point on the specified segment. - /// + /// + /// The ILineString, whose point is returned. /// The point to test. public static Coordinate ClosestPoint(this ILineString self, Coordinate testPoint) {