[fdo-commits] r2527 - trunk/Fdo/Unmanaged/Inc/Fdo/Filter

svn_fdo at osgeo.org svn_fdo at osgeo.org
Thu Feb 15 14:58:18 EST 2007


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

Modified:
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperations.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperator.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonCondition.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonOperations.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ConditionType.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceCondition.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceOperations.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/Filter.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/FilterException.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/GeometricCondition.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/InCondition.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/NullCondition.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialCondition.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialOperations.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperations.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperator.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ValueExpressionCollection.h
Log:
FDO4: API - Update API documentation included in the FDO header files

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperations.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperations.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperations.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -23,15 +23,10 @@
 #pragma once
 #endif
 
+/// \ingroup (enums)
 /// \brief
 /// The FdoBinaryLogicalOperations enumeration lists the binary logical operations
 /// available.
-/// <param name="FdoBinaryLogicalOperations_And">
-/// Perform a logical And between the two filters
-/// </param>
-/// <param name="FdoBinaryLogicalOperations_Or">
-/// Perform a logical Or between the two filters
-/// </param>
 enum FdoBinaryLogicalOperations
 {
     /// Perform a logical And between the two filters.

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperator.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperator.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperator.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -33,8 +33,8 @@
 /// filters to be combined via a logical "and" or a logical "or".
 class FdoBinaryLogicalOperator : public FdoLogicalOperator
 {
+/// \cond DOXYGEN-IGNORE
 protected:
-/// \cond DOXYGEN-IGNORE
     /// Constructs a default instance of an FdoBinaryLogicalOperator.
     FdoBinaryLogicalOperator();
 
@@ -141,6 +141,7 @@
     FDO_API void Process(FdoIFilterProcessor* p);
 
 /// \cond DOXYGEN-IGNORE
+
     /// \brief
     /// This is an internal method. It returns the well defined text representation of the filter. 
     /// 

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonCondition.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonCondition.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonCondition.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -33,8 +33,8 @@
 /// to test the equality of two expressions.
 class FdoComparisonCondition : public FdoSearchCondition
 {
+/// \cond DOXYGEN-IGNORE
 protected:
-/// \cond DOXYGEN-IGNORE
     /// Constructs a default instance of an FdoComparisonCondition.
     FdoComparisonCondition();
 
@@ -142,6 +142,7 @@
     FDO_API void Process(FdoIFilterProcessor* p);
 
 /// \cond DOXYGEN-IGNORE
+
     /// \brief
     /// This is an internal method. It returns the well defined text representation of the filter. 
     /// 

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonOperations.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonOperations.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonOperations.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -23,38 +23,10 @@
 #pragma once
 #endif
 
+/// \ingroup (enums)
 /// \brief
 /// The FdoComparisonOperations enumeration lists the comparison operations
 /// available.
-/// <param name="FdoComparisonOperations_EqualTo">
-/// Test to see if the left and right expressions are equal
-/// </param>
-/// <param name="FdoComparisonOperations_NotEqualTo">
-/// Test to see if the left and right expressions are not equal
-/// </param>
-/// <param name="FdoComparisonOperations_GreaterThan">
-/// Test to see if the left expression is greater than the right expression
-/// </param>
-/// <param name="FdoComparisonOperations_GreaterThanOrEqualTo">
-/// Test to see if the left expression is greater than or equal to the right expression
-/// </param>
-/// <param name="FdoComparisonOperations_LessThan">
-/// Test to see if the left expression is less than the right expression
-/// </param>
-/// <param name="FdoComparisonOperations_LessThanOrEqualTo">
-/// Test to see if the left expression is less than or equal to the right expression
-/// </param>
-/// <param name="FdoComparisonOperations_Like">
-/// Test to see if the left expression matches the pattern specified by the
-/// right expression.  Wildcard characters supported in the pattern are:
-///
-/// %    Any string of zero or more characters;
-/// _    Any single character;
-/// []   Any single character within the specified range ([a-f]) or set 
-/// ([abcdef]);
-/// [^]  Any single character not within the specified range ([^a-f]) or 
-/// set ([^abcdef]).
-/// </param>
 enum FdoComparisonOperations
 {
     /// Test to see if the left and right expressions are equal.

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ConditionType.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ConditionType.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ConditionType.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -23,38 +23,17 @@
 #pragma once
 #endif
 
+/// \ingroup (enums)
 /// \brief
 /// The FdoConditionType enumeration defines the filter condition types available. 
 /// This enumeration is used in the capabilities.
-/// <param name="FdoConditionType_Comparison">
-/// Tests if one expression is equal, not equal, greater than, less than, 
-/// greater than or equal to, or less than or equal to another expression
-/// </param>
-/// <param name="FdoConditionType_Like">
-/// Tests if the value of a specified data property matches a specified pattern
-/// </param>
-/// <param name="FdoConditionType_In">
-/// Tests if the value of a specified data property is within a given set 
-/// of literal values
-/// </param>
-/// <param name="FdoConditionType_Null">
-/// Tests if the value of a specified data property is null
-/// </param>
-/// <param name="FdoConditionType_Spatial">
-/// Tests whether the value of a geometric property and a literal geometric 
-/// value satisfy the spatial relationship implied by the operation
-/// </param>
-/// <param name="FdoConditionType_Distance">
-/// Tests whether the value of a geometric property is within or beyond a 
-/// specified distance of a literal geometric value
-/// </param>
 enum FdoConditionType
 {
     /// Tests if one expression is equal, not equal, greater than, less than, 
     /// greater than or equal to, or less than or equal to another expression.
     FdoConditionType_Comparison,
 
-    /// Tests if the value of a specified data property is matches a specified pattern.
+    /// Tests if the value of a specified data property matches a specified pattern.
     FdoConditionType_Like,
 
     /// Tests if the value of a specified data property is within a given set 

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceCondition.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceCondition.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceCondition.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -40,8 +40,8 @@
 /// will indicate this limitation.
 class FdoDistanceCondition : public FdoGeometricCondition
 {
+/// \cond DOXYGEN-IGNORE
 protected:
-/// \cond DOXYGEN-IGNORE
     /// Constructs a default instance of an FdoDistanceCondition.
     FdoDistanceCondition();
 
@@ -172,6 +172,7 @@
     FDO_API void Process(FdoIFilterProcessor* p);
 
 /// \cond DOXYGEN-IGNORE
+
     /// \brief
     /// This is an internal method. It returns the well defined text representation of the filter. 
     /// 

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceOperations.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceOperations.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceOperations.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -23,16 +23,9 @@
 #pragma once
 #endif
 
+/// \ingroup (enums)
 /// \brief
 /// The FdoDistanceOperations enumeration lists the distance conditions available.
-/// <param name="FdoDistanceOperations_Beyond">
-/// Test to see if the geometric property value lies beyond a specified
-/// distance of a literal geometric value
-/// </param>
-/// <param name="FdoDistanceOperations_Within">
-/// Test to see if the geometric property value lies within a specified
-/// distance of a literal geometric value
-/// </param>
 enum FdoDistanceOperations
 {
     /// Test to see if the geometric property value lies beyond a specified

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/Filter.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/Filter.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/Filter.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -36,8 +36,8 @@
 /// of a filter.
 class FdoFilter : public FdoIDisposable
 {
+/// \cond DOXYGEN-IGNORE
 protected:
-/// \cond DOXYGEN-IGNORE
     FdoFilter();
     virtual ~FdoFilter();
 /// \endcond
@@ -78,6 +78,7 @@
     FDO_API FdoString* ToString();
 
 /// \cond DOXYGEN-IGNORE
+
     /// \brief
     /// This is an internal method. It returns the well defined text representation of the filter. 
     /// 
@@ -154,8 +155,8 @@
     /// 
     FDO_API static FdoFilter* Combine(FdoString* lhs, FdoBinaryLogicalOperations operation, FdoString* rhs);
 
+/// \cond DOXYGEN-IGNORE
 protected:
-/// \cond DOXYGEN-IGNORE
     wchar_t*    m_toString;
 /// \endcond
 };

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/FilterException.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/FilterException.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/FilterException.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -31,8 +31,8 @@
 /// environment-specific.
 class FdoFilterException : public FdoException
 {
+/// \cond DOXYGEN-IGNORE
 protected:
-/// \cond DOXYGEN-IGNORE
     /// Constructs a default instance of an FdoFilterException.
     FdoFilterException();
 

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/GeometricCondition.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/GeometricCondition.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/GeometricCondition.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -34,8 +34,8 @@
 /// and FdoSpatialCondition.
 class FdoGeometricCondition : public FdoSearchCondition
 {
+/// \cond DOXYGEN-IGNORE
 protected:
-/// \cond DOXYGEN-IGNORE
     /// Constructs a default instance of an FdoGeometricCondition.
     FdoGeometricCondition();
 

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/InCondition.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/InCondition.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/InCondition.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -34,8 +34,8 @@
 /// values.
 class FdoInCondition : public FdoSearchCondition
 {
+/// \cond DOXYGEN-IGNORE
 protected:
-/// \cond DOXYGEN-IGNORE
     /// Constructs a default instance of an FdoInCondition.
     FdoInCondition();
 

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/NullCondition.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/NullCondition.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/NullCondition.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -32,8 +32,8 @@
 /// if the value of a specified data property is null.
 class FdoNullCondition : public FdoSearchCondition
 {
+/// \cond DOXYGEN-IGNORE
 protected:
-/// \cond DOXYGEN-IGNORE
     /// Constructs a default instance of an FdoNullCondition.
     FdoNullCondition();
 
@@ -111,6 +111,7 @@
     FDO_API void Process(FdoIFilterProcessor* p);
 
 /// \cond DOXYGEN-IGNORE
+
     /// \brief
     /// This is an internal method. It returns the well defined text representation of the filter. 
     /// 

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialCondition.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialCondition.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialCondition.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -40,8 +40,8 @@
 /// will indicate this limitation.
 class FdoSpatialCondition : public FdoGeometricCondition
 {
+/// \cond DOXYGEN-IGNORE
 protected:
-/// \cond DOXYGEN-IGNORE
     /// Constructs a default instance of an FdoSpatialCondition.
     FdoSpatialCondition();
 
@@ -148,6 +148,7 @@
     FDO_API void Process(FdoIFilterProcessor* p);
 
 /// \cond DOXYGEN-IGNORE
+
     /// \brief
     /// This is an internal method. It returns the well defined text representation of the filter. 
     /// 

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialOperations.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialOperations.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialOperations.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -23,52 +23,9 @@
 #pragma once
 #endif
 
+/// \ingroup (enums)
 /// \brief
 /// The FdoSpatialOperations enumeration lists the spatial conditions available.
-/// <param name="FdoSpatialOperations_Contains">
-/// Test to see if the geometric property value spatially contains the
-/// literal geometric value
-/// </param>
-/// <param name="FdoSpatialOperations_Crosses">
-/// Test to see if the geometric property value spatially crosses the given
-/// geometry
-/// </param>
-/// <param name="FdoSpatialOperations_Disjoint">
-/// Test to see if the geometric property value spatially is spatially
-/// disjoint from the given geometry
-/// </param>
-/// <param name="FdoSpatialOperations_Equals">
-/// Test to see if the geometric property value is spatially equal to the
-/// given geometry
-/// </param>
-/// <param name="FdoSpatialOperations_Intersects">
-/// Test to see if the geometric property value spatially intersects the
-/// given geometry
-/// </param>
-/// <param name="FdoSpatialOperations_Overlaps">
-/// Test to see if the geometric property value spatially overlaps the given
-/// geometry
-/// </param>
-/// <param name="FdoSpatialOperations_Touches">
-/// Test to see if the geometric property value spatially touches the given
-/// geometry
-/// </param>
-/// <param name="FdoSpatialOperations_Within">
-/// Test to see if the geometric property value is spatially within the
-/// given geometry
-/// </param>
-/// <param name="FdoSpatialOperations_CoveredBy">
-/// Test to see if the geometric property value is covered by the interior
-/// and boundary of the given geometry
-/// </param>
-/// <param name="FdoSpatialOperations_Inside">
-/// Test to see if the geometric property value is inside the interior
-/// of the given geometry, not touching the boundary
-/// </param>
-/// <param name="FdoSpatialOperations_EnvelopeIntersects">
-/// Test to see if the envelope of the referenced geometric property value intersects the
-/// given geometry
-/// </param>
 enum FdoSpatialOperations
 {
     /// Test to see if the geometric property value spatially contains the
@@ -79,7 +36,7 @@
     /// geometry.
     FdoSpatialOperations_Crosses,
 
-    /// Test to see if the geometric property value spatially is spatially
+    /// Test to see if the geometric property value is spatially
     /// disjoint from the given geometry.
     FdoSpatialOperations_Disjoint,
 

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperations.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperations.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperations.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -22,12 +22,10 @@
 #pragma once
 #endif
 
+/// \ingroup (enums)
 /// \brief
 /// The FdoUnaryLogicalOperations enumeration lists the unary logical operations
 /// available.
-/// <param name="FdoUnaryLogicalOperations_Not">
-/// Perform a logical Not of the filter
-/// </param>
 enum FdoUnaryLogicalOperations
 {
     /// Perform a logical Not of the filter.

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperator.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperator.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperator.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -33,8 +33,8 @@
 /// logical "Not" to be performed against a filter.
 class FdoUnaryLogicalOperator : public FdoLogicalOperator
 {
+/// \cond DOXYGEN-IGNORE
 protected:
-/// \cond DOXYGEN-IGNORE
     /// Constructs a default instance of a UnaryLogicalOperator.
     FdoUnaryLogicalOperator();
 
@@ -120,6 +120,7 @@
     FDO_API void Process(FdoIFilterProcessor* p);
 
 /// \cond DOXYGEN-IGNORE
+
     /// \brief
     /// This is an internal method. It returns the well defined text representation of the filter. 
     /// 

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ValueExpressionCollection.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ValueExpressionCollection.h	2007-02-15 19:56:00 UTC (rev 2526)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Filter/ValueExpressionCollection.h	2007-02-15 19:58:18 UTC (rev 2527)
@@ -32,8 +32,8 @@
 /// The FdoValueExpressionCollection class represents a collection of FdoValueExpression classes.
 class FdoValueExpressionCollection: public FdoCollection<FdoValueExpression, FdoFilterException> 
 {
+/// \cond DOXYGEN-IGNORE
 protected:
-/// \cond DOXYGEN-IGNORE
     /// Constructs a default empty instance of a ValueCollection.
     FdoValueExpressionCollection():FdoCollection<FdoValueExpression, FdoFilterException>()
     {



More information about the fdo-commits mailing list