[fdo-commits] r2521 - trunk/Fdo/Unmanaged/Inc/Spatial

[svn_fdo at osgeo.org]

Author: gregboone
Date: 2007-02-15 14:24:18 -0500 (Thu, 15 Feb 2007)
New Revision: 2521

Modified:
   trunk/Fdo/Unmanaged/Inc/Spatial/SpatialGeometryValidity.h
   trunk/Fdo/Unmanaged/Inc/Spatial/SpatialGridTransform.h
Log:
FDO4: API - Update API documentation included in the FDO header files

Modified: trunk/Fdo/Unmanaged/Inc/Spatial/SpatialGeometryValidity.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Spatial/SpatialGeometryValidity.h	2007-02-15 19:23:49 UTC (rev 2520)
+++ trunk/Fdo/Unmanaged/Inc/Spatial/SpatialGeometryValidity.h	2007-02-15 19:24:18 UTC (rev 2521)
@@ -20,35 +20,27 @@
 #ifdef _WIN32
 #pragma once
 #endif
+
+/// \ingroup (enums)
 /// \brief
 ///  FdoSpatialGeometryValidity is an enumeration to denote the validity of a Geometry
 /// during a test of type and dimensionality..
-/// <param name="FdoSpatialGeometryValidity_None">
-/// Indicates no specific validity; used for unknown or default states.
-/// </param>
-/// <param name="FdoSpatialGeometryValidity_Valid">
-/// Geometry passes a test.
-/// </param>
-/// <param name="FdoSpatialGeometryValidity_Invalid">
-/// Geometry fails a test.
-/// </param>
-/// <param name="FdoSpatialGeometryValidity_InvalidButCanBeApproximated">
-/// Geometry fails a test, but could be approximated 
-/// using allowed types.
-/// </param>
-/// <param name="FdoSpatialGeometryValidity_InvalidDueToDimensionality">
-/// Geometry fails a test due to having an disallowed dimensionality.
-/// </param>
 enum FdoSpatialGeometryValidity
 {
+    /// Indicates no specific validity; used for unknown or default states.
     FdoSpatialGeometryValidity_None = 0,
 
+    /// Geometry passes a test.
     FdoSpatialGeometryValidity_Valid = 1,
 
+    /// Geometry fails a test.
     FdoSpatialGeometryValidity_Invalid = 2,
 
+    /// Geometry fails a test, but could be approximated 
+    /// using allowed types.
     FdoSpatialGeometryValidity_InvalidButCanBeApproximated = 3,
 
+    /// Geometry fails a test due to having an disallowed dimensionality.
     FdoSpatialGeometryValidity_InvalidDueToDimensionality = 4
 };
 

Modified: trunk/Fdo/Unmanaged/Inc/Spatial/SpatialGridTransform.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Spatial/SpatialGridTransform.h	2007-02-15 19:23:49 UTC (rev 2520)
+++ trunk/Fdo/Unmanaged/Inc/Spatial/SpatialGridTransform.h	2007-02-15 19:24:18 UTC (rev 2521)
@@ -114,6 +114,7 @@
     virtual ~FdoSpatialGridTransform();
 };
 
+/// \ingroup (typedefs)
 /// \brief
 /// FdoSpatialGridTransformP is a FdoPtr on FdoSpatialGridTransform, provided for convenience.
 typedef FdoPtr<FdoSpatialGridTransform> FdoSpatialGridTransformP;