[geos-commits] r3012 - trunk/include/geos/linearref
svn_geos at osgeo.org
svn_geos at osgeo.org
Sat Jun 19 07:14:21 EDT 2010
Author: strk
Date: 2010-06-19 11:14:21 +0000 (Sat, 19 Jun 2010)
New Revision: 3012
Modified:
trunk/include/geos/linearref/LengthIndexOfPoint.h
trunk/include/geos/linearref/LinearIterator.h
Log:
Dox cleanup
Modified: trunk/include/geos/linearref/LengthIndexOfPoint.h
===================================================================
--- trunk/include/geos/linearref/LengthIndexOfPoint.h 2010-06-18 16:15:08 UTC (rev 3011)
+++ trunk/include/geos/linearref/LengthIndexOfPoint.h 2010-06-19 11:14:21 UTC (rev 3012)
@@ -34,6 +34,15 @@
namespace linearref // geos::linearref
{
+/**
+ * \brief
+ * Computes the length index of the point
+ * on a linear Geometry nearest a given Coordinate.
+ *
+ * The nearest point is not necessarily unique; this class
+ * always computes the nearest point closest to
+ * the start of the geometry.
+ */
class LengthIndexOfPoint
{
@@ -53,17 +62,17 @@
LengthIndexOfPoint(const geom::Geometry *linearGeom);
/**
- * Find the nearest location along a linear {@link Geometry} to a given point.
+ * Find the nearest location along a linear Geometry to a given point.
*
* @param inputPt the coordinate to locate
* @return the location of the nearest point
*/
double indexOf(const geom::Coordinate& inputPt) const;
- /**
- * Finds the nearest index along the linear {@link Geometry}
- * to a given {@link Coordinate}
- * after the specified minimum index.
+ /** \brief
+ * Finds the nearest index along the linear Geometry
+ * to a given Coordinate after the specified minimum index.
+ *
* If possible the location returned will be strictly greater than the
* <code>minLocation</code>.
* If this is not possible, the
Modified: trunk/include/geos/linearref/LinearIterator.h
===================================================================
--- trunk/include/geos/linearref/LinearIterator.h 2010-06-18 16:15:08 UTC (rev 3011)
+++ trunk/include/geos/linearref/LinearIterator.h 2010-06-19 11:14:21 UTC (rev 3012)
@@ -31,11 +31,11 @@
namespace geos { namespace linearref
{
-/**
+/** \brief
* An iterator over the components and coordinates of a linear geometry
- * ({@link LineString}s and {@link MultiLineString}s.
+ * (LineString or MultiLineString).
*
- * The standard usage pattern for a {@link LinearIterator} is:
+ * The standard usage pattern for a LinearIterator is:
*
* <pre>
* for (LinearIterator it = new LinearIterator(...); it.hasNext(); it.next()) {
@@ -52,7 +52,7 @@
{
public:
/**
- * Creates an iterator initialized to the start of a linear {@link Geometry}
+ * Creates an iterator initialized to the start of a linear Geometry
*
* @param linear the linear geometry to iterate over
*/
@@ -142,7 +142,8 @@
const unsigned int numLines;
/**
- * Invariant: currentLine <> null if the iterator is pointing at a valid coordinate
+ * Invariant: currentLine <> null if the iterator is pointing
+ * at a valid coordinate
*/
void loadCurrentLine();
More information about the geos-commits
mailing list