Geometry Boost List: [ggl] [doc] Index template parameters for get/set accessors?

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

Mateusz Loskot wrote:
> Hi,
> 
> 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?

OK, I think I find what's going on.
The Index is documented for wrong get/set versions.
So, the fix is just to shuffle the comments to right places.

Best regards,
-- 
Mateusz Loskot, http://mateusz.loskot.net
Charter Member of OSGeo, http://osgeo.org