[geos-commits] r4257 - trunk/include/geos/geom

Sandro Santilli strk at kbt.io
Wed Sep 7 06:06:53 PDT 2016


Author: strk
Date: 2016-09-07 06:06:53 -0700 (Wed, 07 Sep 2016)
New Revision: 4257

Modified:
   trunk/include/geos/geom/Geometry.h
   trunk/include/geos/geom/LineString.h
Log:
Fix documentation typos.

Courtesy of Todd Trimble <todd.trimble at gmail.com>

Modified: trunk/include/geos/geom/Geometry.h
===================================================================
--- trunk/include/geos/geom/Geometry.h	2016-09-07 13:05:34 UTC (rev 4256)
+++ trunk/include/geos/geom/Geometry.h	2016-09-07 13:06:53 UTC (rev 4257)
@@ -656,7 +656,7 @@
 
 	/**
 	 *  Performs an operation on the coordinates in this Geometry's
-	 *  CoordinateSequences.s
+	 *  CoordinateSequences.
 	 *  If the filter reports that a coordinate value has been changed,
 	 *  {@link #geometryChanged} will be called automatically.
 	 *

Modified: trunk/include/geos/geom/LineString.h
===================================================================
--- trunk/include/geos/geom/LineString.h	2016-09-07 13:05:34 UTC (rev 4256)
+++ trunk/include/geos/geom/LineString.h	2016-09-07 13:06:53 UTC (rev 4257)
@@ -60,12 +60,12 @@
  *  pair of consecutive vertices.
  *  Consecutive vertices may be equal.
  *  The line segments in the line may intersect each other (in other words,
- *  the linestring may "curl back" in itself and self-intersect.
+ *  the linestring may "curl back" in itself and self-intersect).
  *  Linestrings with exactly two identical points are invalid.
  *  
  *  A linestring must have either 0 or 2 or more points.
  *  If these conditions are not met, the constructors throw
- *  an {@link IllegalArgumentException}
+ *  an {@link IllegalArgumentException}.
  */
 class GEOS_DLL LineString: public virtual Geometry, public Lineal {
 
@@ -79,10 +79,11 @@
 	virtual ~LineString();
 
 	/**
-	 * Creates and returns a full copy of this {@link LineString} object.
-	 * (including all coordinates contained by it).
+	 * \brief
+	 * Creates and returns a full copy of this {@link LineString} object
+	 * (including all coordinates contained by it)
 	 *
-	 * @return a clone of this instance
+	 * @return A clone of this instance
 	 */
 	virtual Geometry *clone() const;
 
@@ -164,7 +165,7 @@
 	 * Normalizes a LineString. 
 	 *
 	 * A normalized linestring
-	 * has the first point which is not equal to it's reflected point
+	 * has the first point which is not equal to its reflected point
 	 * less than the reflected point.
 	 */
 	virtual void normalize();
@@ -178,7 +179,7 @@
 
 	/**
 	 * Creates a LineString whose coordinates are in the reverse
-	 * order of this objects
+	 * order of this object's
 	 *
 	 * @return a LineString with coordinates in the reverse order
 	 */



More information about the geos-commits mailing list