[fdo-commits] r701 - branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial

[svn_fdo at osgeo.org]

Author: gregboone
Date: 2007-02-01 19:07:02 -0500 (Thu, 01 Feb 2007)
New Revision: 701

Modified:
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialGridTransform.h
   branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialUtility.h
Log:
893057: DOC: FDO Managed API Documentation Updates

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialGridTransform.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialGridTransform.h	2007-02-01 18:13:45 UTC (rev 700)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialGridTransform.h	2007-02-02 00:07:02 UTC (rev 701)
@@ -22,6 +22,9 @@
 
 BEGIN_NAMESPACE_OSGEO_SPATIAL
 
+/// \brief
+/// Class to handle transformations of ordinates between double precision
+/// and integers.  The integer format models a fine grid.
 public __gc class SpatialGridTransform: public NAMESPACE_OSGEO_RUNTIME::Disposable
 {
 public:
@@ -43,9 +46,9 @@
     /// \brief
     /// Transform floating-point ordinates to integer ordinates on the grid.
     /// 
-    /// \param x 
+    /// \param coordinateX 
     /// Input Floating-point X ordinate.
-    /// \param y 
+    /// \param coordinateY 
     /// Input Floating-point Y ordinate.
     /// \param xGrid 
     /// Output Integer X ordinate.
@@ -60,13 +63,13 @@
     /// \brief
     /// Transform integer ordinates on the grid to floating-point ordinates.
     /// 
-    /// \param x 
+    /// \param coordinateX 
     /// Input Floating-point X ordinate.
-    /// \param y 
+    /// \param coordinateY 
     /// Input Floating-point Y ordinate.
-    /// \param x 
+    /// \param coordinateX 
     /// Output Integer X ordinate.
-    /// \param y 
+    /// \param coordinateY 
     /// Output Integer Y ordinate.
     /// 
     /// \return
@@ -74,10 +77,22 @@
     /// 
 	System::Void TransformFromGrid(System::Int64 gridX, System::Int64 gridY, System::Double* coordinateX, System::Double* coordinateY);
 
+/// \cond DOXYGEN-IGNORE
 protected:
 	System::Void ReleaseUnmanagedObject();
+/// \endcond
 
 public:
+    /// \brief
+    /// Constructs an SpatialGridTransform managed object based on an unmanaged instance of the object
+    /// 
+    /// \param unmanaged 
+    /// Input A Pointer to the unmanaged object.
+    /// 
+    /// \param autoDelete 
+    /// Input Indicates if the constructed object should be automatically deleted 
+    /// once it no longer referenced.
+    /// 
 	SpatialGridTransform(System::IntPtr unmanaged, System::Boolean autoDelete);
 
 public private:

Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialUtility.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialUtility.h	2007-02-01 18:13:45 UTC (rev 700)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Spatial/mgSpatialUtility.h	2007-02-02 00:07:02 UTC (rev 701)
@@ -33,6 +33,8 @@
 
 BEGIN_NAMESPACE_OSGEO_SPATIAL
 
+/// \brief
+/// A Spatial utility class.
 public __gc __sealed class SpatialUtility
 {
 public:
@@ -101,9 +103,9 @@
     /// 
     /// \param ring 
     /// Input Ring to test
-    /// \param x 
+    /// \param coordinateX 
     /// Input X ordinate.
-    /// \param y 
+    /// \param coordinateY 
     /// Input Y ordinate.
     /// 
     /// \return
@@ -115,11 +117,11 @@
     /// \brief
     /// Tests whether a point is within a polygon (including its islands) or not.
     /// 
-    /// \param poly 
+    /// \param polygon 
     /// Input Polygon to test
-    /// \param x 
+    /// \param coordinateX 
     /// Input X ordinate.
-    /// \param y 
+    /// \param coordinateY 
     /// Input Y ordinate.
     /// 
     /// \return