Skip to content

Commit 3416c68

Browse files
Last bit of comment tidying
1 parent c67d925 commit 3416c68

6 files changed

Lines changed: 19 additions & 30 deletions

File tree

src/GeoJSON.Net/Converters/CrsConverter.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,36 +7,36 @@
77
namespace GeoJSON.Net.Converters
88
{
99
/// <summary>
10-
/// Converts <see cref="ICRSObject" /> types to and from JSON.
10+
/// Converts <see cref="ICRSObject"/> types to and from JSON.
1111
/// </summary>
1212
public class CrsConverter : JsonConverter
1313
{
1414
/// <summary>
15-
/// Determines whether this instance can convert the specified object type.
15+
/// Determines whether this instance can convert the specified object type.
1616
/// </summary>
1717
/// <param name="objectType">Type of the object.</param>
1818
/// <returns>
19-
/// <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
19+
/// <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
2020
/// </returns>
2121
public override bool CanConvert(Type objectType)
2222
{
2323
return typeof(ICRSObject).GetTypeInfo().IsAssignableFrom(objectType.GetTypeInfo());
2424
}
2525

2626
/// <summary>
27-
/// Reads the JSON representation of the object.
27+
/// Reads the JSON representation of the object.
2828
/// </summary>
2929
/// <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader" /> to read from.</param>
3030
/// <param name="objectType">Type of the object.</param>
3131
/// <param name="existingValue">The existing value of object being read.</param>
3232
/// <param name="serializer">The calling serializer.</param>
3333
/// <returns>
34-
/// The object value.
34+
/// The object value.
3535
/// </returns>
3636
/// <exception cref="Newtonsoft.Json.JsonReaderException">
37-
/// CRS must be null or a json object
37+
/// CRS must be null or a json object
3838
/// or
39-
/// CRS must have a "type" property
39+
/// CRS must have a "type" property
4040
/// </exception>
4141
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
4242
{

src/GeoJSON.Net/Converters/GeometryConverter.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
// <copyright file="GeometryConverter.cs" company="Joerg Battermann">
33
// Copyright © Joerg Battermann 2014
44
// </copyright>
5-
// <summary>
6-
// Defines the GeometryConverter type.
7-
// </summary>
85
// --------------------------------------------------------------------------------------------------------------------
96

107
using System;

src/GeoJSON.Net/Converters/LineStringConverter.cs

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
// <copyright file="PolygonConverter.cs" company="Joerg Battermann">
33
// Copyright © Joerg Battermann 2014
44
// </copyright>
5-
// <summary>
6-
// Defines the LineString type.
7-
// </summary>
85
// --------------------------------------------------------------------------------------------------------------------
96

107
using System;
@@ -16,7 +13,7 @@
1613
namespace GeoJSON.Net.Converters
1714
{
1815
/// <summary>
19-
/// Converter to read and write the <see cref="LineString" /> type.
16+
/// Converter to read and write the <see cref="LineString" /> type.
2017
/// </summary>
2118
public class LineStringConverter : JsonConverter
2219
{

src/GeoJSON.Net/Converters/MultiPointConverter.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@
88
namespace GeoJSON.Net.Converters
99
{
1010
/// <summary>
11-
///
11+
/// Converter to read and write the <see cref="MultiPoint" /> type.
1212
/// </summary>
1313
public class MultiPointConverter : JsonConverter
1414
{
15+
/// <inheritdoc />
1516
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
1617
{
1718
var points = (List<Point>)value;
@@ -31,6 +32,7 @@ public override void WriteJson(JsonWriter writer, object value, JsonSerializer s
3132
}
3233
}
3334

35+
/// <inheritdoc />
3436
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
3537
{
3638
var coordinates = serializer.Deserialize<double[][]>(reader);
@@ -59,6 +61,7 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
5961
}
6062
}
6163

64+
/// <inheritdoc />
6265
public override bool CanConvert(Type objectType)
6366
{
6467
return objectType == typeof(MultiPoint);

src/GeoJSON.Net/Converters/PointConverter.cs

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,12 @@
22
// <copyright file="PositionConverter.cs" company="Joerg Battermann">
33
// Copyright © Joerg Battermann 2014
44
// </copyright>
5-
// <summary>
6-
// Defines the PolygonConverter type.
7-
// </summary>
85
// --------------------------------------------------------------------------------------------------------------------
96

107
using System;
118
using System.Reflection;
12-
using GeoJSON.Net.Exceptions;
139
using GeoJSON.Net.Geometry;
1410
using Newtonsoft.Json;
15-
using Newtonsoft.Json.Linq;
1611

1712
namespace GeoJSON.Net.Converters
1813
{
@@ -45,7 +40,7 @@ public override bool CanConvert(Type objectType)
4540
/// </returns>
4641
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
4742
{
48-
double[] coordinates = null;
43+
double[] coordinates;
4944

5045
try
5146
{

src/GeoJSON.Net/Converters/PolygonConverter.cs

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
// <copyright file="PolygonConverter.cs" company="Joerg Battermann">
33
// Copyright © Joerg Battermann 2014
44
// </copyright>
5-
// <summary>
6-
// Defines the PolygonConverter type.
7-
// </summary>
85
// --------------------------------------------------------------------------------------------------------------------
96

107
using System;
@@ -15,33 +12,33 @@
1512
namespace GeoJSON.Net.Converters
1613
{
1714
/// <summary>
18-
/// Converter to read and write the <see cref="Polygon" /> type.
15+
/// Converter to read and write the <see cref="Polygon" /> type.
1916
/// </summary>
2017
public class PolygonConverter : JsonConverter
2118
{
2219
private static readonly LineStringConverter LineStringConverter = new LineStringConverter();
2320

2421
/// <summary>
25-
/// Determines whether this instance can convert the specified object type.
22+
/// Determines whether this instance can convert the specified object type.
2623
/// </summary>
2724
/// <param name="objectType">Type of the object.</param>
2825
/// <returns>
29-
/// <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
26+
/// <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
3027
/// </returns>
3128
public override bool CanConvert(Type objectType)
3229
{
3330
return objectType == typeof(Polygon);
3431
}
3532

3633
/// <summary>
37-
/// Reads the JSON representation of the object.
34+
/// Reads the JSON representation of the object.
3835
/// </summary>
3936
/// <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader" /> to read from.</param>
4037
/// <param name="objectType">Type of the object.</param>
4138
/// <param name="existingValue">The existing value of object being read.</param>
4239
/// <param name="serializer">The calling serializer.</param>
4340
/// <returns>
44-
/// The object value.
41+
/// The object value.
4542
/// </returns>
4643
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
4744
{
@@ -58,7 +55,7 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
5855
}
5956

6057
/// <summary>
61-
/// Writes the JSON representation of the object.
58+
/// Writes the JSON representation of the object.
6259
/// </summary>
6360
/// <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter" /> to write to.</param>
6461
/// <param name="value">The value.</param>

0 commit comments

Comments
 (0)