[mapguide-commits] r9386 - trunk/MgDev/Common/Geometry/CoordinateSystem

[svn_mapguide at osgeo.org]

Author: jng
Date: 2018-05-03 07:13:19 -0700 (Thu, 03 May 2018)
New Revision: 9386

Modified:
   trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystem.h
Log:
Some API commentary on MgCoordinateSystem to highlight the fact that the index for projection parameters (getting or setting) is 1-based, not 0-based

Modified: trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystem.h
===================================================================
--- trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystem.h	2018-04-09 01:43:13 UTC (rev 9385)
+++ trunk/MgDev/Common/Geometry/CoordinateSystem/CoordinateSystem.h	2018-05-03 14:13:19 UTC (rev 9386)
@@ -700,7 +700,7 @@
     /// Gets the projection parameter count of this coordinate system at the specified index
     ///
     /// \param nIndex (int)
-    /// The index at which to retrieve the projection parameter
+    /// The index at which to retrieve the projection parameter. NOTE: The index is 1-based, not 0-based (ie. The first index will start at 1, not 0)
     ///
     /// \return
     /// The projection parameter at the given index
@@ -712,7 +712,7 @@
     /// Sets the projection parameter of this coordinate system at the specified index
     ///
     /// \param nIndex (int)
-    /// The index at which to set the projection parameter
+    /// The index at which to set the projection parameter. NOTE: The index is 1-based, not 0-based (ie. The first index will start at 1, not 0)
     /// \param dValue (double)
     /// The projection parameter value
     ///