Fixed XML comments structure (placed URLs into remarks tag)

Author: apdevelop

LinqToDBPostGisNetTopologySuite/GeometryAccessors.cs

@@ -6,31 +6,34 @@
 
 namespace LinqToDBPostGisNetTopologySuite
 {
-    // Chapter 8. PostGIS Reference
-    // https://postgis.net/docs/manual-3.0/reference.html
-
     /// <summary>
-    /// 8.4. Geometry Accessors
-    /// https://postgis.net/docs/manual-3.0/reference.html#Geometry_Accessors
+    /// Geometry Accessors
     /// </summary>
+    /// <remarks>
+    /// 8.4. Geometry Accessors https://postgis.net/docs/manual-3.0/reference.html#Geometry_Accessors
+    /// </remarks>
     public static class GeometryAccessors
     {
         /// <summary>
-        /// Returns a LINESTRING representing the exterior ring of the POLYGON geometry. Return NULL if the geometry is not a polygon.
-        /// https://postgis.net/docs/manual-3.0/ST_ExteriorRing.html
+        /// Returns a LINESTRING representing the exterior ring of the POLYGON geometry. Returns NULL if the geometry is not a polygon.
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_ExteriorRing.html
+        /// </remarks>
         /// <param name="geometry">Input geometry</param>
-        /// <returns>Geometry</returns>
+        /// <returns>Exterior ring geometry</returns>
         [Sql.Function("ST_ExteriorRing", ServerSideOnly = true)]
         public static NTSG STExteriorRing(this NTSG geometry)
         {
             throw new InvalidOperationException();
         }
 
         /// <summary>
-        /// Return the number of points in a geometry. Works for all geometries.
-        /// https://postgis.net/docs/manual-3.0/ST_NPoints.html
+        /// Returns the number of points in a geometry.
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_NPoints.html
+        /// </remarks>
         /// <param name="geometry">Input geometry</param>
         /// <returns>Number of points</returns>
         [Sql.Function("ST_NPoints", ServerSideOnly = true)]
@@ -40,9 +43,11 @@ public static int STNPoints(this NTSG geometry)
         }
 
         /// <summary>
-        /// Returns the minimum bounding box for the supplied geometry, as a geometry.
-        /// https://postgis.net/docs/manual-3.0/ST_Envelope.html
+        /// Returns the minimum bounding box for the supplied geometry, as geometry.
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_Envelope.html
+        /// </remarks>
         /// <param name="geometry">Input geometry</param>
         /// <returns>Bounding box geometry</returns>
         [Sql.Function("ST_Envelope", ServerSideOnly = true)]

LinqToDBPostGisNetTopologySuite/GeometryInput.cs

@@ -6,19 +6,20 @@
 
 namespace LinqToDBPostGisNetTopologySuite
 {
-    // Chapter 8. PostGIS Reference
-    // https://postgis.net/docs/manual-3.0/reference.html
-
     /// <summary>
-    /// 8.8. Geometry Output
-    /// https://postgis.net/docs/manual-3.0/reference.html#Geometry_Inputs
+    /// Geometry Input
     /// </summary>
+    /// <remarks>
+    /// 8.8. Geometry Input https://postgis.net/docs/manual-3.0/reference.html#Geometry_Inputs
+    /// </remarks>
     public static class GeometryInput
     {
         /// <summary>
-        /// Constructs a PostGIS ST_Geometry object from the OGC Extended Well-Known Text (EWKT) representation.
-        /// https://postgis.net/docs/manual-3.0/ST_GeomFromEWKT.html
+        /// Constructs geometry from the Extended Well-Known Text (EWKT) representation.
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_GeomFromEWKT.html
+        /// </remarks>
         /// <param name="ewkt">Extended Well-Known Text (EWKT)</param>
         /// <returns>Geometry</returns>
         [Sql.Function("ST_GeomFromEWKT", ServerSideOnly = true)]
@@ -28,9 +29,11 @@ public static NTSG STGeomFromEWKT(string ewkt)
         }
 
         /// <summary>
-        /// Constructs a PostGIS ST_Geometry object from the OGC Well-Known Text (WKT) representation.
-        /// https://postgis.net/docs/manual-3.0/ST_GeomFromText.html
+        /// Constructs geometry from the OGC Well-Known Text (WKT) representation.
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_GeomFromText.html
+        /// </remarks>
         /// <param name="wkt">Well-Known Text (WKT)</param>
         /// <returns>Geometry</returns>
         [Sql.Function("ST_GeomFromText", ServerSideOnly = true)]
@@ -40,9 +43,11 @@ public static NTSG STGeomFromText(string wkt)
         }
 
         /// <summary>
-        /// Constructs a PostGIS ST_Geometry object from the OGC Well-Known Text (WKT) representation.
-        /// https://postgis.net/docs/manual-3.0/ST_GeomFromText.html
+        /// Constructs geometry from the OGC Well-Known Text (WKT) representation with given SRID.
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_GeomFromText.html
+        /// </remarks>
         /// <param name="wkt">Well-Known Text (WKT)</param>
         /// <param name="srid">SRID of geometry</param>
         /// <returns>Geometry</returns>

LinqToDBPostGisNetTopologySuite/GeometryOutput.cs

@@ -6,19 +6,20 @@
 
 namespace LinqToDBPostGisNetTopologySuite
 {
-    // Chapter 8. PostGIS Reference
-    // https://postgis.net/docs/manual-3.0/reference.html
-
     /// <summary>
-    /// 8.9. Geometry Output
-    /// https://postgis.net/docs/manual-3.0/reference.html#Geometry_Outputs
+    /// Geometry Output
     /// </summary>
+    /// <remarks>
+    /// 8.9. Geometry Output https://postgis.net/docs/manual-3.0/reference.html#Geometry_Outputs
+    /// </remarks>
     public static class GeometryOutput
     {
         /// <summary>
         /// Returns the Extended Well-Known Text representation of the geometry prefixed with the SRID.
-        /// https://postgis.net/docs/manual-3.0/ST_AsEWKT.html
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_AsEWKT.html
+        /// </remarks>
         /// <param name="geometry">Input geometry</param>
         /// <returns>Extended Well-Known Text</returns>
         [Sql.Function("ST_AsEWKT", ServerSideOnly = true)]
@@ -29,8 +30,10 @@ public static string STAsEWKT(this NTSG geometry)
 
         /// <summary>
         /// Returns the Well-Known Text representation of the geometry.
-        /// https://postgis.net/docs/manual-3.0/ST_AsText.html
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_AsText.html
+        /// </remarks>
         /// <param name="geometry">Input geometry</param>
         /// <returns>Well-Known Text</returns>
         [Sql.Function("ST_AsText", ServerSideOnly = true)]
@@ -41,8 +44,10 @@ public static string STAsText(this NTSG geometry)
 
         /// <summary>
         /// Returns the Well-Known Binary representation of the geometry.
-        /// https://postgis.net/docs/manual-3.0/ST_AsBinary.html
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_AsBinary.html
+        /// </remarks>
         /// <param name="geometry">Input geometry</param>
         /// <returns>Well-Known Binary</returns>
         [Sql.Function("ST_AsBinary", ServerSideOnly = true)]
@@ -52,9 +57,11 @@ public static byte[] STAsBinary(this NTSG geometry) // TODO: NDR_or_XDR version
         }
 
         /// <summary>
-        /// Return the geometry as a GeoJSON "geometry" object.
-        /// https://postgis.net/docs/manual-3.0/ST_AsGeoJSON.html
+        /// Returns geometry as GeoJSON "geometry" object.
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_AsGeoJSON.html
+        /// </remarks>
         /// <param name="geometry">Input geometry</param>
         /// <returns>GeoJSON</returns>
         [Sql.Function("ST_AsGeoJSON", ServerSideOnly = true)]

LinqToDBPostGisNetTopologySuite/GeometryProcessing.cs

@@ -6,19 +6,20 @@
 
 namespace LinqToDBPostGisNetTopologySuite
 {
-    // Chapter 8. PostGIS Reference
-    // https://postgis.net/docs/manual-3.0/reference.html
-
     /// <summary>
-    /// 8.13. Geometry Processing
-    /// https://postgis.net/docs/manual-3.0/reference.html#Geometry_Processing
+    /// Geometry Processing
     /// </summary>
+    /// <remarks>
+    /// 8.13. Geometry Processing https://postgis.net/docs/manual-3.0/reference.html#Geometry_Processing
+    /// </remarks>
     public static class GeometryProcessing
     {
         /// <summary>
-        /// Returns a geometry that represents all points whose distance from this geometry is less than or equal to distance. 
-        /// https://postgis.net/docs/manual-3.0/ST_Buffer.html
+        /// Returns geometry that represents all points whose distance from this geometry is less than or equal to distance. 
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_Buffer.html
+        /// </remarks>
         /// <param name="geometry">Input geometry</param>
         /// <param name="radius">Buffer radius</param>
         /// <returns>Geometry</returns>

LinqToDBPostGisNetTopologySuite/MeasurementFunctions.cs

@@ -6,19 +6,20 @@
 
 namespace LinqToDBPostGisNetTopologySuite
 {
-    // Chapter 8. PostGIS Reference
-    // https://postgis.net/docs/manual-3.0/reference.html
-
     /// <summary>
-    /// 8.12. Measurement Functions
-    /// https://postgis.net/docs/manual-3.0/reference.html#Measurement_Functions
+    /// Measurement Functions
     /// </summary>
+    /// <remarks>
+    /// 8.12. Measurement Functions https://postgis.net/docs/manual-3.0/reference.html#Measurement_Functions
+    /// </remarks>
     public static class MeasurementFunctions
     {
         /// <summary>
         /// Returns the area of a polygonal geometry. For geometry types a 2D Cartesian (planar) area is computed, with units specified by the SRID.
-        /// https://postgis.net/docs/manual-3.0/ST_Area.html
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_Area.html
+        /// </remarks>
         /// <param name="geometry">Input geometry</param>
         /// <returns>Area</returns>
         [Sql.Function("ST_Area", ServerSideOnly = true)]
@@ -29,8 +30,10 @@ public static double STArea(this NTSG geometry)
 
         /// <summary>
         /// For geometry types returns the minimum 2D Cartesian (planar) distance between two geometries, in projected units (spatial ref units).
-        /// https://postgis.net/docs/manual-3.0/ST_Distance.html
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_Distance.html
+        /// </remarks>
         /// <param name="geometry">Input geometry 1</param>
         /// <param name="other">Input geometry 2</param>
         /// <returns>Distance between two geometries</returns>
@@ -42,8 +45,10 @@ public static double STDistance(this NTSG geometry, NTSG other)
 
         /// <summary>
         /// Returns the 2D Cartesian length of the geometry if it is a LineString, MultiLineString, ST_Curve, ST_MultiCurve. For areal geometries 0 is returned; use ST_Perimeter instead.
-        /// https://postgis.net/docs/manual-3.0/ST_Length.html
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_Length.html
+        /// </remarks>
         /// <param name="geometry">Input geometry</param>
         /// <returns>Length</returns>
         [Sql.Function("ST_Length", ServerSideOnly = true)]
@@ -54,8 +59,10 @@ public static double STLength(this NTSG geometry)
 
         /// <summary>
         /// Returns the 2D perimeter of the geometry if it is a ST_Surface, ST_MultiSurface (Polygon, MultiPolygon). Zero is returned for non-areal geometries. For linear geometries use ST_Length.
-        /// https://postgis.net/docs/manual-3.0/ST_Perimeter.html
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_Perimeter.html
+        /// </remarks>
         /// <param name="geometry">Input geometry</param>
         /// <returns>Perimeter</returns>
         [Sql.Function("ST_Perimeter", ServerSideOnly = true)]

LinqToDBPostGisNetTopologySuite/SpatialReferenceSystemFunctions.cs

@@ -6,21 +6,22 @@
 
 namespace LinqToDBPostGisNetTopologySuite
 {
-    // Chapter 8. PostGIS Reference
-    // https://postgis.net/docs/manual-3.0/reference.html
-
     /// <summary>
-    /// 8.7. Spatial Reference System Functions
-    /// https://postgis.net/docs/manual-3.0/reference.html#SRS_Functions
+    /// Spatial Reference System Functions
     /// </summary>
+    /// <remarks>
+    /// 8.7. Spatial Reference System Functions https://postgis.net/docs/manual-3.0/reference.html#SRS_Functions
+    /// </remarks>
     public static class SpatialReferenceSystemFunctions
     {
         /// <summary>
-        /// Returns the spatial reference identifier for the ST_Geometry as defined in spatial_ref_sys table.
-        /// https://postgis.net/docs/manual-3.0/ST_SRID.html
+        /// Returns the spatial reference identifier for the geometry as defined in spatial_ref_sys table.
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_SRID.html
+        /// </remarks>
         /// <param name="geometry">Input geometry</param>
-        /// <returns>Spatial reference identifier</returns>
+        /// <returns>Spatial Reference System Identifier</returns>
         [Sql.Function("ST_SRID", ServerSideOnly = true)]
         public static int STSrId(this NTSG geometry)
         {
@@ -29,10 +30,12 @@ public static int STSrId(this NTSG geometry)
 
         /// <summary>
         /// Returns a new geometry with its coordinates transformed to a different spatial reference system.
-        /// https://postgis.net/docs/manual-3.0/ST_Transform.html
         /// </summary>
-        /// <param name="geometry ">Input geometry</param>
-        /// <param name="srid">Spatial reference system ID</param>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_Transform.html
+        /// </remarks>
+        /// <param name="geometry">Input geometry</param>
+        /// <param name="srid">Spatial Reference System Identifier</param>
         /// <returns>Transformed geometry</returns>
         [Sql.Function("ST_Transform", ServerSideOnly = true)]
         public static NTSG STTransform(this NTSG geometry, int srid)

LinqToDBPostGisNetTopologySuite/SpatialRelationships.cs

@@ -6,19 +6,20 @@
 
 namespace LinqToDBPostGisNetTopologySuite
 {
-    // Chapter 8. PostGIS Reference
-    // https://postgis.net/docs/manual-3.0/reference.html
-
     /// <summary>
-    /// 8.11. Spatial Relationships
-    /// https://postgis.net/docs/manual-3.0/reference.html#Spatial_Relationships
+    /// Spatial Relationships
     /// </summary>
+    /// <remarks>
+    /// 8.11. Spatial Relationships https://postgis.net/docs/manual-3.0/reference.html#Spatial_Relationships
+    /// </remarks>
     public static class SpatialRelationships
     {
         /// <summary>
-        /// Returns TRUE if geometry 2 is completely inside geometry 1.
-        /// https://postgis.net/docs/manual-3.0/ST_Contains.html
+        /// Returns true if geometry 2 is completely inside geometry 1.
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_Contains.html
+        /// </remarks>
         /// <param name="geometry">Input geometry 1</param>
         /// <param name="other">Input geometry 2</param>
         /// <returns>Is contains</returns>
@@ -29,12 +30,14 @@ public static bool STContains(this NTSG geometry, NTSG other)
         }
 
         /// <summary>
-        /// Returns true if no point in other geometry 2 is outside geometry 1
-        /// https://postgis.net/docs/manual-3.0/ST_Covers.html
+        /// Returns true if no point in geometry 2 is outside geometry 1
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_Covers.html
+        /// </remarks>
         /// <param name="geometry">Input geometry 1</param>
         /// <param name="other">Input geometry 2</param>
-        /// <returns>Is intersects</returns>
+        /// <returns>Is covers</returns>
         [Sql.Function("ST_Covers", ServerSideOnly = true)]
         public static bool STCovers(this NTSG geometry, NTSG other)
         {
@@ -43,8 +46,10 @@ public static bool STCovers(this NTSG geometry, NTSG other)
 
         /// <summary>
         /// Tests if two geometries shares any portion of space then they intersect.
-        /// https://postgis.net/docs/manual-3.0/ST_Intersects.html
         /// </summary>
+        /// <remarks>
+        /// See https://postgis.net/docs/manual-3.0/ST_Intersects.html
+        /// </remarks>
         /// <param name="geometry">Input geometry 1</param>
         /// <param name="other">Input geometry 2</param>
         /// <returns>Is intersects</returns>

LinqToDBPostGisNpgsqlTypes/GeometryEditors.cs

@@ -26,7 +26,7 @@ public static PostgisGeometry STReverse(this PostgisGeometry geom)
         /// http://postgis.refractions.net/documentation/manual-1.5/ST_SetSRID.html
         /// </summary>
         /// <param name="geom">Input geometry</param>
-        /// <param name="srid">Spatial reference system ID</param>
+        /// <param name="srid">Spatial Reference System Identifier</param>
         /// <returns></returns>
         [Sql.Function("ST_SetSRID", ServerSideOnly = true)]
         public static PostgisGeometry STSetSrid(this PostgisGeometry geom, int srid)
@@ -39,7 +39,7 @@ public static PostgisGeometry STSetSrid(this PostgisGeometry geom, int srid)
         /// http://postgis.refractions.net/documentation/manual-1.5/ST_Transform.html
         /// </summary>
         /// <param name="geom">Input geometry</param>
-        /// <param name="srid">Spatial reference system ID</param>
+        /// <param name="srid">Spatial Reference System Identifier</param>
         /// <returns>Transformed geometry</returns>
         [Sql.Function("ST_Transform", ServerSideOnly = true)]
         public static PostgisGeometry STTransform(this PostgisGeometry geom, int srid)