Boost logo

Geometry :

Subject: [ggl] [doc] Index template parameters for get/set accessors?
From: Mateusz Loskot (mateusz)
Date: 2010-03-07 17:40:37


For get/set functions in access.hpp, there is template parameters Index
documented but none of the get/set prototypes make use of it.

For example, get function

template <std::size_t Dimension, typename Geometry>
inline typename coordinate_type<Geometry>::type get(
  Geometry const& geometry)

has the following bit in its doxygen comment:

\tparam Index index
- for Point: don't specify
- for Box: min_corner or max_corner
- for Segment: 0 / 1

Is this doc out of sync or the Index is there on purpose?

Best regards,

Mateusz Loskot,
Charter Member of OSGeo,

Geometry list run by mateusz at