More comment tidying

Author: matt-lethargic

src/GeoJSON.Net/CoordinateReferenceSystem/CRSBase.cs

@@ -2,33 +2,29 @@
 // <copyright file="CRSBase.cs" company="Joerg Battermann">
 //   Copyright © Joerg Battermann 2014
 // </copyright>
-// <summary>
-//   Defines the CRSBase type.
-// </summary>
 // --------------------------------------------------------------------------------------------------------------------
 
+using System;
 using System.Collections.Generic;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
-using GeoJSON.Net.Converters;
-using System;
 
 namespace GeoJSON.Net.CoordinateReferenceSystem
 {
     /// <summary>
-    ///     Base class for all IGeometryObject implementing types
+    /// Base class for all IGeometryObject implementing types
     /// </summary>
     [JsonObject(MemberSerialization.OptIn)]
     public abstract class CRSBase : IEqualityComparer<CRSBase>, IEquatable<CRSBase>
     {
         /// <summary>
-        ///     Gets the properties.
+        /// Gets the properties.
         /// </summary>
         [JsonProperty(PropertyName = "properties", Required = Required.Always)]
         public Dictionary<string, object> Properties { get; internal set; }
 
         /// <summary>
-        ///     Gets the type of the GeometryObject object.
+        /// Gets the type of the GeometryObject object.
         /// </summary>
         [JsonProperty(PropertyName = "type", Required = Required.Always)]
         [JsonConverter(typeof(StringEnumConverter))]
@@ -108,7 +104,7 @@ public bool Equals(CRSBase left, CRSBase right)
             {
                 return false;
             }
-            return left.Equals(right);
+            return left != null && left.Equals(right);
         }
 
         /// <summary>

src/GeoJSON.Net/CoordinateReferenceSystem/CRSType.cs

@@ -2,35 +2,35 @@
 // <copyright file="CRSType.cs" company="Joerg Battermann">
 //   Copyright © Joerg Battermann 2014
 // </copyright>
-// <summary>
-// Defines the GeoJSON Coordinate Reference System Objects (CRS) types originally defined in the <see cref="http://geojson.org/geojson-spec.html#coordinate-reference-system-objects">geojson.org v1.0 spec</see>.
-// The current spec <see cref="https://tools.ietf.org/html/rfc7946#section-4" removes the CRS type, but allows to be left in for backwards compatibility.  
-// </summary>
 // --------------------------------------------------------------------------------------------------------------------
 
 using System.Runtime.Serialization;
 
 namespace GeoJSON.Net.CoordinateReferenceSystem
 {
     /// <summary>
-    ///     Defines the GeoJSON Coordinate Reference System Objects (CRS) types as defined in the
+    /// Defines the GeoJSON Coordinate Reference System Objects (CRS) types as originally defined in the geojson.org v1.0 spec
     /// </summary>
+    /// <remarks>
+    /// Originally defined http://geojson.org/geojson-spec.html#coordinate-reference-system-objects
+    /// The current RFC removes the CRS type, but allows to be left in for backwards compatibility. See https://tools.ietf.org/html/rfc7946#section-4
+    /// </remarks>
     public enum CRSType
     {
         /// <summary>
-        ///     Defines a CRS type where the CRS cannot be assumed
+        /// Defines a CRS type where the CRS cannot be assumed
         /// </summary>
         [EnumMember(Value = "unspecified")]
         Unspecified,
 
         /// <summary>
-        ///     Defines the Named CRS type.
+        /// Defines the Named CRS type.
         /// </summary>
         [EnumMember(Value = "name")]
         Name,
 
         /// <summary>
-        ///     Defines the Linked CRS type.
+        /// Defines the Linked CRS type.
         /// </summary>
         [EnumMember(Value = "link")]
         Link

src/GeoJSON.Net/CoordinateReferenceSystem/DefaultCRS.cs

@@ -2,34 +2,35 @@
 // <copyright file="GeometryCollection.cs" company="Joerg Battermann">
 //   Copyright © Joerg Battermann 2014
 // </copyright>
-// <summary>
-// Defines the GeoJSON Coordinate Reference System Objects (CRS) types originally defined in the <see cref="http://geojson.org/geojson-spec.html#coordinate-reference-system-objects">geojson.org v1.0 spec</see>.
-// The current spec <see cref="https://tools.ietf.org/html/rfc7946#section-4" removes the CRS type, but allows to be left in for backwards compatibility.  
-// </summary>
 // --------------------------------------------------------------------------------------------------------------------
 
 namespace GeoJSON.Net.CoordinateReferenceSystem
 {
     /// <summary>
-    ///     The default CRS is a geographic coordinate reference system,
-    ///     using the WGS84 datum, and with longitude and latitude units of decimal degrees.
-    ///     see https://tools.ietf.org/html/rfc7946#section-4
+    /// The default CRS is a geographic coordinate reference system,
+    /// using the WGS84 datum, and with longitude and latitude units of decimal degrees.
+    /// see https://tools.ietf.org/html/rfc7946#section-4
     /// </summary>
+    /// <remarks>
+    /// Defines the GeoJSON Coordinate Reference System Objects (CRS) types originally defined in the geojson.org v1.0 spec
+    /// see http://geojson.org/geojson-spec.html#coordinate-reference-system-objects.
+    /// The current RFC removes the CRS type, but allows to be left in for backwards compatibility. See https://tools.ietf.org/html/rfc7946#section-4
+    /// </remarks>
     public class DefaultCRS : NamedCRS
     {
         /// <summary>
-        ///     Initializes a new instance of the <see cref="DefaultCRS" /> class.
+        /// Initializes a new instance of the <see cref="DefaultCRS" /> class.
         /// </summary>
         private DefaultCRS()
             : base("urn:ogc:def:crs:OGC::CRS84")
         {
         }
 
         /// <summary>
-        ///     Gets the instance.
+        /// Gets the instance.
         /// </summary>
         /// <value>
-        ///     The instance.
+        /// The instance.
         /// </value>
         public static DefaultCRS Instance { get; } = new DefaultCRS();
     }

src/GeoJSON.Net/CoordinateReferenceSystem/ICRSObject.cs

@@ -2,9 +2,6 @@
 // <copyright file="ICRSObject.cs" company="Joerg Battermann">
 //   Copyright © Joerg Battermann 2014
 // </copyright>
-// <summary>
-//   Base Interface for CRSBase Object types.
-// </summary>
 // --------------------------------------------------------------------------------------------------------------------
 
 namespace GeoJSON.Net.CoordinateReferenceSystem

src/GeoJSON.Net/CoordinateReferenceSystem/LinkedCRS.cs

@@ -2,10 +2,6 @@
 // <copyright file="LinkedCRS.cs" company="Joerg Battermann">
 //   Copyright © Joerg Battermann 2014
 // </copyright>
-// <summary>
-// Defines the <see cref="http://geojson.org/geojson-spec.html#named-crs">Linked CRS type</see>.
-// The current spec <see cref="https://tools.ietf.org/html/rfc7946#section-4" removes the CRS type, but allows to be left in for backwards compatibility. 
-// </summary>
 // --------------------------------------------------------------------------------------------------------------------
 
 using System;
@@ -14,18 +10,23 @@
 namespace GeoJSON.Net.CoordinateReferenceSystem
 {
     /// <summary>
-    ///     Defines the <see cref="http://geojson.org/geojson-spec.html#linked-crs">Linked CRS type</see>.
+    /// Defines the Linked CRS type.
     /// </summary>
+    /// <remarks>
+    /// This was originally defined in the spec http://geojson.org/geojson-spec.html#named-crs
+    /// The current RFC removes the CRS type, but allows to be left in for backwards compatibility. 
+    /// See https://tools.ietf.org/html/rfc7946#section-4
+    /// </remarks>
     public class LinkedCRS : CRSBase, ICRSObject
     {
         /// <summary>
-        ///     Initializes a new instance of the <see cref="LinkedCRS" /> class.
+        /// Initializes a new instance of the <see cref="LinkedCRS" /> class.
         /// </summary>
         /// <param name="href">
-        ///     The mandatory href member must be a dereferenceable URI.
+        /// The mandatory href member must be a dereferenceable URI.
         /// </param>
         /// <param name="type">
-        ///     The optional type member will be put in the properties Dictionary
+        /// The optional type member will be put in the properties Dictionary
         /// </param>
         public LinkedCRS(string href, string type = "")
         {
@@ -51,13 +52,13 @@ public LinkedCRS(string href, string type = "")
         }
 
         /// <summary>
-        ///     Initializes a new instance of the <see cref="LinkedCRS" /> class.
+        /// Initializes a new instance of the <see cref="LinkedCRS" /> class.
         /// </summary>
         /// <param name="href">
-        ///     The mandatory href member must be a dereferenceable URI.
+        /// The mandatory href member must be a dereferenceable URI.
         /// </param>
         /// <param name="type">
-        ///     The optional type member will be put in the properties Dictionary
+        /// The optional type member will be put in the properties Dictionary
         /// </param>
         public LinkedCRS(Uri href, string type = "") : this(href != null ? href.ToString() : null, type)
         {

src/GeoJSON.Net/CoordinateReferenceSystem/NamedCRS.cs

@@ -2,27 +2,28 @@
 // <copyright file="NamedCRS.cs" company="Joerg Battermann">
 //   Copyright © Joerg Battermann 2014
 // </copyright>
-// <summary>
-// Defines the <see cref="http://geojson.org/geojson-spec.html#named-crs">Named CRS type</see>.
-// The current spec <see cref="https://tools.ietf.org/html/rfc7946#section-4" removes the CRS type, but allows to be left in for backwards compatibility.  
-// </summary>
 // --------------------------------------------------------------------------------------------------------------------
 using System;
 using System.Collections.Generic;
 
 namespace GeoJSON.Net.CoordinateReferenceSystem
 {
     /// <summary>
-    ///     Defines the Named CRS type.
+    /// Defines the Named CRS type. 
     /// </summary>
+    /// <remarks>
+    /// See http://geojson.org/geojson-spec.html#named-crs
+    /// The current RFC removes the CRS type, but allows to be left in for backwards compatibility.
+    /// See https://tools.ietf.org/html/rfc7946#section-4
+    /// </remarks>
     public class NamedCRS : CRSBase, ICRSObject
     {
         /// <summary>
-        ///     Initializes a new instance of the <see cref="NamedCRS" /> class.
+        /// Initializes a new instance of the <see cref="NamedCRS" /> class.
         /// </summary>
         /// <param name="name">
-        ///     The mandatory name member must be a string identifying a coordinate reference system. OGC CRS URNs such as
-        ///     'urn:ogc:def:crs:OGC:1.3:CRS84' shall be preferred over legacy identifiers such as 'EPSG:4326'.
+        /// The mandatory name member must be a string identifying a coordinate reference system. OGC CRS URNs such as
+        /// 'urn:ogc:def:crs:OGC:1.3:CRS84' shall be preferred over legacy identifiers such as 'EPSG:4326'.
         /// </param>
         public NamedCRS(string name)
         {

src/GeoJSON.Net/CoordinateReferenceSystem/UnspecifiedCRS.cs

@@ -54,7 +54,7 @@ public bool Equals(ICRSObject obj)
             {
                 return false;
             }
-            return left.Equals(right);
+            return left != null && left.Equals(right);
         }
 
         /// <summary>

src/GeoJSON.Net/Exceptions/ParsingException.cs

@@ -2,9 +2,6 @@
 // <copyright file="ParsingException.cs" company="Joerg Battermann">
 //   Copyright © Joerg Battermann 2014
 // </copyright>
-// <summary>
-//   Defines the ParsingException type.
-// </summary>
 // --------------------------------------------------------------------------------------------------------------------
 
 namespace GeoJSON.Net.Exceptions

src/GeoJSON.Net/Feature/Feature.cs

@@ -2,9 +2,6 @@
 // <copyright file="Feature.cs" company="Joerg Battermann">
 //   Copyright © Joerg Battermann 2014
 // </copyright>
-// <summary>
-//   Defines the Feature type.
-// </summary>
 // --------------------------------------------------------------------------------------------------------------------
 
 using System.Collections.Generic;
@@ -18,12 +15,15 @@
 namespace GeoJSON.Net.Feature
 {
     /// <summary>
-    ///     A GeoJSON <see cref="https://tools.ietf.org/html/rfc7946#section-3.2">Feature Object</see>.
+    /// A GeoJSON Feature Object.
     /// </summary>
+    /// <remarks>
+    /// See https://tools.ietf.org/html/rfc7946#section-3.2
+    /// </remarks>
     public class Feature : GeoJSONObject, IEqualityComparer<Feature>, IEquatable<Feature>
     {
         /// <summary>
-        ///     Initializes a new instance of the <see cref="Feature" /> class.
+        /// Initializes a new instance of the <see cref="Feature" /> class.
         /// </summary>
         /// <param name="geometry">The Geometry Object.</param>
         /// <param name="properties">The properties.</param>
@@ -39,12 +39,12 @@ public Feature(IGeometryObject geometry, Dictionary<string, object> properties =
         }
 
         /// <summary>
-        ///     Initializes a new instance of the <see cref="Feature" /> class.
+        /// Initializes a new instance of the <see cref="Feature" /> class.
         /// </summary>
         /// <param name="geometry">The Geometry Object.</param>
         /// <param name="properties">
-        ///     Class used to fill feature properties. Any public member will be added to feature
-        ///     properties
+        /// Class used to fill feature properties. Any public member will be added to feature
+        /// properties
         /// </param>
         /// <param name="id">The (optional) identifier.</param>
         public Feature(IGeometryObject geometry, object properties, string id = null)
@@ -67,10 +67,10 @@ public Feature(IGeometryObject geometry, object properties, string id = null)
         }
 
         /// <summary>
-        ///     Gets or sets the geometry.
+        /// Gets or sets the geometry.
         /// </summary>
         /// <value>
-        ///     The geometry.
+        /// The geometry.
         /// </value>
         [JsonProperty(PropertyName = "geometry", Required = Required.AllowNull)]
         [JsonConverter(typeof(GeometryConverter))]
@@ -84,7 +84,7 @@ public Feature(IGeometryObject geometry, object properties, string id = null)
         public string Id { get; set; }
 
         /// <summary>
-        ///     Gets the properties.
+        /// Gets the properties.
         /// </summary>
         /// <value>The properties.</value>
         [JsonProperty(PropertyName = "properties", Required = Required.AllowNull)]

src/GeoJSON.Net/Feature/FeatureCollection.cs

@@ -2,9 +2,6 @@
 // <copyright file="FeatureCollection.cs" company="Joerg Battermann">
 //   Copyright © Joerg Battermann 2014
 // </copyright>
-// <summary>
-//   Defines the FeatureCollection type.
-// </summary>
 // --------------------------------------------------------------------------------------------------------------------
 
 using System;
@@ -15,34 +12,34 @@
 namespace GeoJSON.Net.Feature
 {
     /// <summary>
-    ///     Defines the FeatureCollection type.
+    /// Defines the FeatureCollection type.
     /// </summary>
     public class FeatureCollection : GeoJSONObject, IEqualityComparer<FeatureCollection>, IEquatable<FeatureCollection>
     {
         /// <summary>
-        ///     Initializes a new instance of the <see cref="FeatureCollection" /> class.
+        /// Initializes a new instance of the <see cref="FeatureCollection" /> class.
         /// </summary>
         public FeatureCollection() : this(new List<Feature>())
         {
         }
 
         /// <summary>
-        ///     Initializes a new instance of the <see cref="FeatureCollection" /> class.
+        /// Initializes a new instance of the <see cref="FeatureCollection" /> class.
         /// </summary>
         /// <param name="features">The features.</param>
         public FeatureCollection(List<Feature> features)
         {
             if (features == null)
             {
-                throw new ArgumentNullException("features");
+                throw new ArgumentNullException(nameof(features));
             }
 
             Features = features;
             Type = GeoJSONObjectType.FeatureCollection;
         }
 
         /// <summary>
-        ///     Gets the features.
+        /// Gets the features.
         /// </summary>
         /// <value>The features.</value>
         [JsonProperty(PropertyName = "features", Required = Required.Always)]
@@ -91,7 +88,7 @@ public bool Equals(FeatureCollection left, FeatureCollection right)
             {
                 return false;
             }
-            return left.Equals(right);
+            return left != null && left.Equals(right);
         }
 
         /// <summary>
@@ -124,6 +121,5 @@ public int GetHashCode(FeatureCollection other)
         }
 
         #endregion
-
     }
 }