CSHARP-685: Added doc comments to GeoJson object model.

Author: rstam

MongoDB.Driver/GeoJsonObjectModel/GeoJson.cs

@@ -19,29 +19,55 @@
 
 namespace MongoDB.Driver.GeoJsonObjectModel
 {
+    /// <summary>
+    /// Represents a GeoJson 2D position (x, y).
+    /// </summary>
     [BsonSerializer(typeof(GeoJson2DCoordinatesSerializer))]
     public class GeoJson2DCoordinates : GeoJsonCoordinates
     {
         // private fields
         private ReadOnlyCollection<double> _values;
 
         // constructors
+        /// <summary>
+        /// Initializes a new instance of the <see cref="GeoJson2DCoordinates"/> class.
+        /// </summary>
+        /// <param name="x">The x coordinate.</param>
+        /// <param name="y">The y coordinate.</param>
         public GeoJson2DCoordinates(double x, double y)
         {
             _values = new ReadOnlyCollection<double>(new[] { x, y });
         }
 
         // public properties
+        /// <summary>
+        /// Gets the coordinate values.
+        /// </summary>
+        /// <value>
+        /// The coordinate values.
+        /// </value>
         public override ReadOnlyCollection<double> Values
         {
             get { return _values; }
         }
 
+        /// <summary>
+        /// Gets the X coordinate.
+        /// </summary>
+        /// <value>
+        /// The X coordinate.
+        /// </value>
         public double X
         {
             get { return _values[0]; }
         }
 
+        /// <summary>
+        /// Gets the Y coordinate.
+        /// </summary>
+        /// <value>
+        /// The Y coordinate.
+        /// </value>
         public double Y
         {
             get { return _values[1]; }

MongoDB.Driver/GeoJsonObjectModel/GeoJson2DCoordinates.cs

@@ -19,29 +19,55 @@
 
 namespace MongoDB.Driver.GeoJsonObjectModel
 {
+    /// <summary>
+    /// Represents a GeoJson 2D geographic position (longitude, latitude).
+    /// </summary>
     [BsonSerializer(typeof(GeoJson2DGeographicCoordinatesSerializer))]
     public class GeoJson2DGeographicCoordinates : GeoJsonCoordinates
     {
         // private fields
         private ReadOnlyCollection<double> _values;
 
         // constructors
+        /// <summary>
+        /// Initializes a new instance of the <see cref="GeoJson2DGeographicCoordinates"/> class.
+        /// </summary>
+        /// <param name="longitude">The longitude.</param>
+        /// <param name="latitude">The latitude.</param>
         public GeoJson2DGeographicCoordinates(double longitude, double latitude)
         {
             _values = new ReadOnlyCollection<double>(new[] { longitude, latitude });
         }
 
         // public properties
+        /// <summary>
+        /// Gets the coordinate values.
+        /// </summary>
+        /// <value>
+        /// The coordinate values.
+        /// </value>
         public override ReadOnlyCollection<double> Values
         {
             get { return _values; }
         }
 
+        /// <summary>
+        /// Gets the longitude.
+        /// </summary>
+        /// <value>
+        /// The longitude.
+        /// </value>
         public double Longitude
         {
             get { return _values[0]; }
         }
 
+        /// <summary>
+        /// Gets the latitude.
+        /// </summary>
+        /// <value>
+        /// The latitude.
+        /// </value>
         public double Latitude
         {
             get { return _values[1]; }

MongoDB.Driver/GeoJsonObjectModel/GeoJson2DGeographicCoordinates.cs

@@ -19,29 +19,55 @@
 
 namespace MongoDB.Driver.GeoJsonObjectModel
 {
+    /// <summary>
+    /// Represents a GeoJson 2D projected position (easting, northing).
+    /// </summary>
     [BsonSerializer(typeof(GeoJson2DProjectedCoordinatesSerializer))]
     public class GeoJson2DProjectedCoordinates : GeoJsonCoordinates
     {
         // private fields
         private ReadOnlyCollection<double> _values;
 
         // constructors
+        /// <summary>
+        /// Initializes a new instance of the <see cref="GeoJson2DProjectedCoordinates"/> class.
+        /// </summary>
+        /// <param name="easting">The easting.</param>
+        /// <param name="northing">The northing.</param>
         public GeoJson2DProjectedCoordinates(double easting, double northing)
         {
             _values = new ReadOnlyCollection<double>(new[] { easting, northing });
         }
 
         // public properties
+        /// <summary>
+        /// Gets the coordinate values.
+        /// </summary>
+        /// <value>
+        /// The coordinate values.
+        /// </value>
         public override ReadOnlyCollection<double> Values
         {
             get { return _values; }
         }
 
+        /// <summary>
+        /// Gets the easting.
+        /// </summary>
+        /// <value>
+        /// The easting.
+        /// </value>
         public double Easting
         {
             get { return _values[0]; }
         }
 
+        /// <summary>
+        /// Gets the northing.
+        /// </summary>
+        /// <value>
+        /// The northing.
+        /// </value>
         public double Northing
         {
             get { return _values[1]; }

MongoDB.Driver/GeoJsonObjectModel/GeoJson2DProjectedCoordinates.cs

@@ -19,34 +19,67 @@
 
 namespace MongoDB.Driver.GeoJsonObjectModel
 {
+    /// <summary>
+    /// Represents a GeoJson 3D position (x, y, z).
+    /// </summary>
     [BsonSerializer(typeof(GeoJson3DCoordinatesSerializer))]
     public class GeoJson3DCoordinates : GeoJsonCoordinates
     {
         // private fields
         private ReadOnlyCollection<double> _values;
 
         // constructors
+        /// <summary>
+        /// Initializes a new instance of the <see cref="GeoJson3DCoordinates"/> class.
+        /// </summary>
+        /// <param name="x">The x coordinate.</param>
+        /// <param name="y">The y coordinate.</param>
+        /// <param name="z">The z coordinate.</param>
         public GeoJson3DCoordinates(double x, double y, double z)
         {
             _values = new ReadOnlyCollection<double>(new[] { x, y, z });
         }
 
         // public properties
+        /// <summary>
+        /// Gets the coordinate values.
+        /// </summary>
+        /// <value>
+        /// The coordinate values.
+        /// </value>
         public override ReadOnlyCollection<double> Values
         {
             get { return _values; }
         }
 
+        /// <summary>
+        /// Gets the X coordinate.
+        /// </summary>
+        /// <value>
+        /// The X coordinate.
+        /// </value>
         public double X
         {
             get { return _values[0]; }
         }
 
+        /// <summary>
+        /// Gets the Y coordinate.
+        /// </summary>
+        /// <value>
+        /// The Y coordinate.
+        /// </value>
         public double Y
         {
             get { return _values[1]; }
         }
 
+        /// <summary>
+        /// Gets the Z coordinate.
+        /// </summary>
+        /// <value>
+        /// The Z coordinate.
+        /// </value>
         public double Z
         {
             get { return _values[2]; }

MongoDB.Driver/GeoJsonObjectModel/GeoJson3DCoordinates.cs

@@ -19,34 +19,67 @@
 
 namespace MongoDB.Driver.GeoJsonObjectModel
 {
+    /// <summary>
+    /// Represents a GeoJson 3D geographic position (longitude, latitude, altitude).
+    /// </summary>
     [BsonSerializer(typeof(GeoJson3DGeographicCoordinatesSerializer))]
     public class GeoJson3DGeographicCoordinates : GeoJsonCoordinates
     {
         // private fields
         private ReadOnlyCollection<double> _values;
 
         // constructors
+        /// <summary>
+        /// Initializes a new instance of the <see cref="GeoJson3DGeographicCoordinates"/> class.
+        /// </summary>
+        /// <param name="longitude">The longitude.</param>
+        /// <param name="latitude">The latitude.</param>
+        /// <param name="altitude">The altitude.</param>
         public GeoJson3DGeographicCoordinates(double longitude, double latitude, double altitude)
         {
             _values = new ReadOnlyCollection<double>(new[] { longitude, latitude, altitude });
         }
 
         // public properties
+        /// <summary>
+        /// Gets the coordinate values.
+        /// </summary>
+        /// <value>
+        /// The coordinate values.
+        /// </value>
         public override ReadOnlyCollection<double> Values
         {
             get { return _values; }
         }
 
+        /// <summary>
+        /// Gets the longitude.
+        /// </summary>
+        /// <value>
+        /// The longitude.
+        /// </value>
         public double Longitude
         {
             get { return _values[0]; }
         }
 
+        /// <summary>
+        /// Gets the latitude.
+        /// </summary>
+        /// <value>
+        /// The latitude.
+        /// </value>
         public double Latitude
         {
             get { return _values[1]; }
         }
 
+        /// <summary>
+        /// Gets the altitude.
+        /// </summary>
+        /// <value>
+        /// The altitude.
+        /// </value>
         public double Altitude
         {
             get { return _values[2]; }

MongoDB.Driver/GeoJsonObjectModel/GeoJson3DGeographicCoordinates.cs

@@ -19,34 +19,67 @@
 
 namespace MongoDB.Driver.GeoJsonObjectModel
 {
+    /// <summary>
+    /// Represents a GeoJson 3D projected position (easting, northing, altitude).
+    /// </summary>
     [BsonSerializer(typeof(GeoJson3DProjectedCoordinatesSerializer))]
     public class GeoJson3DProjectedCoordinates : GeoJsonCoordinates
     {
         // private fields
         private ReadOnlyCollection<double> _values;
 
         // constructors
+        /// <summary>
+        /// Initializes a new instance of the <see cref="GeoJson3DProjectedCoordinates"/> class.
+        /// </summary>
+        /// <param name="easting">The easting.</param>
+        /// <param name="northing">The northing.</param>
+        /// <param name="altitude">The altitude.</param>
         public GeoJson3DProjectedCoordinates(double easting, double northing, double altitude)
         {
             _values = new ReadOnlyCollection<double>(new[] { easting, northing, altitude });
         }
 
         // public properties
+        /// <summary>
+        /// Gets the coordinate values.
+        /// </summary>
+        /// <value>
+        /// The coordinate values.
+        /// </value>
         public override ReadOnlyCollection<double> Values
         {
             get { return _values; }
         }
 
+        /// <summary>
+        /// Gets the easting.
+        /// </summary>
+        /// <value>
+        /// The easting.
+        /// </value>
         public double Easting
         {
             get { return _values[0]; }
         }
 
+        /// <summary>
+        /// Gets the northing.
+        /// </summary>
+        /// <value>
+        /// The northing.
+        /// </value>
         public double Northing
         {
             get { return _values[1]; }
         }
 
+        /// <summary>
+        /// Gets the altitude.
+        /// </summary>
+        /// <value>
+        /// The altitude.
+        /// </value>
         public double Altitude
         {
             get { return _values[2]; }