[fdo-commits] r774 - in branches/3.2.x/Fdo/Unmanaged/Inc: Common
Common/Io Common/Xml Common/Xsl Fdo/ClientServices
Fdo/Commands Fdo/Commands/Locking
Fdo/Commands/LongTransaction Fdo/Commands/Schema
Fdo/Commands/SpatialContext Fdo/Commands/Sql
Fdo/Commands/UnitOfMeasure Fdo/Connections
Fdo/Connections/Capabilities Fdo/Expression Fdo/Filter
Fdo/Raster Fdo/Schema Fdo/Xml Geometry Spatial
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Wed Feb 14 16:48:31 EST 2007
Author: gregboone
Date: 2007-02-14 16:48:31 -0500 (Wed, 14 Feb 2007)
New Revision: 774
Modified:
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Array.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Compare.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Context.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Dictionary.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/DictionaryElement.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Dimensionality.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Disposable.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Exception.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/FdoTypes.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/GeometryType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/IStreamReader.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/ByteStreamReader.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/FileStream.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/MemoryStream.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/Stream.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/TextReader.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/TextWriter.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/NamedCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Ptr.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Semaphore.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Stack.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/StringP.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Vector.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/Attribute.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/AttributeCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/CharDataHandler.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/CopyHandler.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/Reader.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/SaxContext.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/SaxHandler.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/SkipElementHandler.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/Writer.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/XmlException.h
branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xsl/Transformer.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ClientServiceException.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ConnectionManager.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/Provider.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderNameTokens.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderRegistry.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/CommandException.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/CommandType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/IdentifierCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/ConflictType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockStrategy.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionConflictResolution.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionFreezeOperations.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivilegeOperations.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivileges.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionSetOperations.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/OrderingOption.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/ParameterValue.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValue.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValueCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalClassMapping.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMapping.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMappingCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalPropertyMapping.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMapping.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMappingCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/ISpatialContextReader.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextExtentType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextMismatchException.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Sql/ISQLDataReader.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/UnitOfMeasure/BaseUnit.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ArgumentDefinition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/FunctionDefinition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ISchemaCapabilities.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SchemaElementNameType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SignatureDefinition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ThreadCapability.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionException.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionState.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/ProviderDatastoreType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BLOBValue.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BinaryExpression.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BinaryOperations.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BooleanValue.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ByteValue.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/CLOBValue.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ComputedIdentifier.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DataValue.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DataValueCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DateTimeValue.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DecimalValue.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DoubleValue.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ExpressionException.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ExpressionType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Function.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/GeometryValue.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Identifier.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Int16Value.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Int32Value.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Int64Value.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Parameter.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/SingleValue.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/StringValue.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/UnaryExpression.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/UnaryOperations.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperations.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperator.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonCondition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonOperations.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ConditionType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceCondition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceOperations.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/Filter.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/FilterException.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/GeometricCondition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/InCondition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/NullCondition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialCondition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialOperations.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperations.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperator.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ValueExpressionCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModel.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModelType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataOrganization.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/AssociationPropertyDefinition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/AutogenerationException.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/Class.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassCapabilities.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassDefinition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DataPropertyDefinition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DataPropertyDefinitionCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DataType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DeleteRule.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureClass.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureClassCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureSchema.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureSchemaCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/GeometricPropertyDefinition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/GeometricType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/MergeContext.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkClass.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkFeatureClass.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkLayerClass.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkLinkFeatureClass.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkNodeFeatureClass.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ObjectPropertyDefinition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ObjectType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/OrderType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyDefinition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyDefinitionCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyValueConstraintType.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/RasterPropertyDefinition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaAttributeDictionary.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaElement.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaElementState.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaException.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/TopoFeaturePropertyDefinition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/TopoGeometryPropertyDefinition.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/Topology.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/UniqueConstraint.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/UniqueConstraintCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ClassMapping.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ClassMappingCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/Context.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/Deserializable.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ElementMapping.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ElementMappingCollection.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureContext.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureFlags.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureHandler.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeaturePropertyReader.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeaturePropertyWriter.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureReader.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureWriter.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/Flags.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/NameCollectionHandler.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SchemaMapping.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SpatialContextFlags.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SpatialContextReader.h
branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SpatialContextWriter.h
branches/3.2.x/Fdo/Unmanaged/Inc/Geometry/DirectPositionImpl.h
branches/3.2.x/Fdo/Unmanaged/Inc/Geometry/EnvelopeImpl.h
branches/3.2.x/Fdo/Unmanaged/Inc/Spatial/SpatialGeometryValidity.h
branches/3.2.x/Fdo/Unmanaged/Inc/Spatial/SpatialGridTransform.h
Log:
FDO4: API - Update API documentation included in the FDO header files
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Array.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Array.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Array.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -344,14 +344,17 @@
*(this->GetData()+i) = newElement;
}
+/// \ingroup (typedefs)
/// \brief
/// Dynamic array of bytes (FdoByte).
typedef FdoArray<FdoByte> FdoByteArray;
+/// \ingroup (typedefs)
/// \brief
/// Dynamic array of doubles (FdoDouble).
typedef FdoArray<FdoDouble> FdoDoubleArray;
+/// \ingroup (typedefs)
/// \brief
/// Dynamic array of integers (FdoInt32).
typedef FdoArray<FdoInt32> FdoIntArray;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Compare.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Compare.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Compare.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,6 +23,7 @@
#endif
/// \cond DOXYGEN-IGNORE
+
/// \brief
/// FdoCompareType is an enumeration of different value comparison results when comparing
/// value1 and value2
@@ -43,7 +44,9 @@
FdoCompareType_Greater,
FdoCompareType_Equal
};
+/// \endcond
+/// \cond DOXYGEN-IGNORE
// General function for comparing values of simple types or types that define the comparison operators.
template< class T> FdoCompareType FdoCompare( T val1, T val2 )
{
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Context.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Context.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Context.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -81,6 +81,7 @@
FdoPtr<Errors> mErrors;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoContextP is a FdoPtr on FdoContext, provided for convenience.
typedef FdoPtr<FdoContext> FdoContextP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Dictionary.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Dictionary.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Dictionary.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -46,6 +46,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoDictionaryP is a FdoPtr on FdoDictionary, provided for convenience.
typedef FdoPtr<FdoDictionary> FdoDictionaryP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/DictionaryElement.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/DictionaryElement.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/DictionaryElement.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -34,7 +34,7 @@
///
/// \param name
/// Input the name of the element (required)
- /// \param name
+ /// \param value
/// Input the value of the element. Can be blank (L"")
///
/// \return
@@ -79,8 +79,8 @@
///
FDO_API_COMMON virtual void SetValue(FdoString* value);
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of a FdoDictionaryElement.
FDO_API_COMMON FdoDictionaryElement()
{
@@ -101,6 +101,7 @@
FdoStringP mValue;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoDictionaryElementP is a FdoPtr on FdoDictionaryElement, provided for convenience.
typedef FdoPtr<FdoDictionaryElement> FdoDictionaryElementP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Dimensionality.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Dimensionality.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Dimensionality.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -24,6 +24,7 @@
#pragma once
#endif
#ifdef __cplusplus
+ /// \ingroup (enums)
/// \brief
/// FdoDimensionality is an enumeration to describe the presence of spatial dimensions in ordinated data.
///
@@ -31,24 +32,19 @@
/// Values of this enumeration are bit-field definitions.
/// They can be combined via bitwise OR or separated via bitwise AND.
/// \remarks
- /// /// The XY value is zero, thus indicating that all spatial data
+ /// The XY value is zero, thus indicating that all spatial data
/// is assumed to carry X and Y dimensions.
///
- ///
- /// \param FdoDimensionality_XY
- /// X and Y dimensions are present.
- /// \param FdoDimensionality_Z
- /// Z dimension is present.
- /// \param FdoDimensionality_M
- /// M ('measure') dimension is present.
- ///
enum FdoDimensionality
#else
typedef enum
#endif
{
+ /// X and Y dimensions are present.
FdoDimensionality_XY = 0,
+ /// Z dimension is present.
FdoDimensionality_Z = 1,
+ /// M ('measure') dimension is present.
FdoDimensionality_M = 2
#ifdef __cplusplus
};
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Disposable.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Disposable.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Disposable.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -22,7 +22,7 @@
#include <Common/IDisposable.h>
/// \cond DOXYGEN-IGNORE
-/// \brief
+// \brief
/// FdoDisposable is a default implementor for the FdoIDisposable interface.
/// It simply deletes itself
class FdoDisposable : public virtual FdoIDisposable
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Exception.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Exception.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Exception.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -217,8 +217,8 @@
///
FDO_API_COMMON static FdoString* NLSGetMessage(FdoInt32 msgNum, char* defMsg, char* catalog, va_list arguments);
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
wchar_t* m_message;
FdoException* m_cause;
@@ -226,6 +226,9 @@
/// \endcond
};
+
+/// \ingroup (typedefs)
+/// \brief
/// FdoExceptionP is a FdoPtr on FdoException, provided for convenience.
typedef FdoPtr<FdoException> FdoExceptionP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/FdoTypes.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/FdoTypes.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/FdoTypes.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -27,19 +27,24 @@
#include <stdint.h>
#endif
+/// \ingroup (typedefs)
/// \brief
/// FdoByte is used to store a single byte of data
typedef unsigned char FdoByte;
#ifdef _WIN32
+/// \ingroup (typedefs)
/// \brief
/// FdoInt8 is used to store a 8 bit signed integer
typedef _int8 FdoInt8;
+/// \ingroup (typedefs)
/// \brief
/// FdoInt16 is used to store a 16 bit signed integer
typedef _int16 FdoInt16;
+/// \ingroup (typedefs)
/// \brief
/// FdoInt32 is used to store a 32 bit signed integer
typedef _int32 FdoInt32;
+/// \ingroup (typedefs)
/// \brief
/// FdoInt64 is used to store a 64 bit signed integer
typedef _int64 FdoInt64;
@@ -51,26 +56,33 @@
typedef int64_t FdoInt64;
/// \endcond
#endif
+/// \ingroup (typedefs)
/// \brief
/// FdoCharacter is used to store a wide character
typedef wchar_t FdoCharacter;
+/// \ingroup (typedefs)
/// \brief
/// FdoString is used to store a constant wide character.
/// Variables declared as FdoString* point to constant wide character strings.
typedef const wchar_t FdoString;
+/// \ingroup (typedefs)
/// \brief
/// FdoBoolean is used to store a boolean (true/false) value
typedef bool FdoBoolean;
+/// \ingroup (typedefs)
/// \brief
/// FdoVoid is used to reference a void (type undetermined)
typedef void FdoVoid;
+/// \ingroup (typedefs)
/// \brief
/// FdoDouble is used to store a double precision floating point number
typedef double FdoDouble;
+/// \ingroup (typedefs)
/// \brief
/// FdoFloat is used to store a single precision floating point number
typedef float FdoFloat;
+/// \ingroup (typedefs)
/// \brief
/// FdoSize is used to store a size value (e.g. number of elements in an array)
typedef size_t FdoSize;
@@ -79,24 +91,14 @@
/// FdoDateTime is used to store dates, times, or both. After constructing
/// the class you determine which portion has been specified. The data members
/// are public so they can be accessed directly. No range checking is performed.
-/// <param name="year">
-/// Year in the range of 1 to 9999
-/// </param>
-/// <param name="month">
-/// Month in the range of 1 to 12 inclusive (January = 1)
-/// </param>
-/// <param name="day">
-/// Day of the month in the range of 1 to 31 inclusive
-/// </param>
-/// <param name="hour">
-/// Hour since midnight in the range of 0 to 23
-/// </param>
-/// <param name="minute">
-/// Minutes after hour in the range of 0 to 59
-/// </param>
-/// <param name="seconds">
-/// Seconds after minute in the range of 0 to 59.9999999
-/// </param>
+/// <ul>
+/// <li>Year is in the range of 1 to 9999</li>
+/// <li>Month is in the range of 1 to 12 inclusive (January = 1)</li>
+/// <li>Day of the month is in the range of 1 to 31 inclusive</li>
+/// <li>Hour is since midnight in the range of 0 to 23</li>
+/// <li>Minutes are after hour in the range of 0 to 59</li>
+/// <li>Seconds are after minute in the range of 0 to 59.9999999</li>
+/// </ul>
class FdoDateTime
{
public:
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/GeometryType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/GeometryType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/GeometryType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,64 +23,51 @@
#endif
#ifdef __cplusplus
+/// \ingroup (enums)
/// \brief
/// FdoGeometryType is an enumeration to denote the type of a Geometry.
///
/// \remarks
/// This enumeration applies to types that derive from FdoIGeometry.
- ///
- /// \param FdoGeometryType_None
- /// Indicates no specific type; used for "unknown", "don't care" or an incompletely constructed Geometry object.
- /// \param FdoGeometryType_Point
- /// Point type (FdoIPoint).
- /// \param FdoGeometryType_LineString
- /// LineString type (FdoILineString).
- /// \param FdoGeometryType_Polygon
- /// Polygon type (FdoIPolygon).
- /// \param FdoGeometryType_MultiPoint
- /// MultiPoint type (FdoIMultiPoint).
- /// \param FdoGeometryType_MultiLineString
- /// MultiLineString type (FdoIMultiLineString).
- /// \param FdoGeometryType_MultiPolygon
- /// MultiPolygon type (FdoIMultiPolygon).
- /// \param FdoGeometryType_MultiGeometry
- /// MultiGeometry type (FdoIMultiGeometry).
- /// \param FdoGeometryType_CurveString
- /// CurveString type (FdoICurveString).
- /// \param FdoGeometryType_CurvePolygon
- /// CurvePolygon type (FdoICurvePolygon).
- /// \param FdoGeometryType_MultiCurveString
- /// MultiCurveString type (FdoIMultiCurveString).
- /// \param FdoGeometryType_MultiCurvePolygon
- /// MultiCurvePolygon type (FdoIMultiCurvePolygon).
- ///
enum FdoGeometryType
#else
typedef enum
#endif
{
+ /// Indicates no specific type; used for "unknown", "don't care" or an incompletely constructed Geometry object.
FdoGeometryType_None = 0,
+ /// Point type (FdoIPoint).
FdoGeometryType_Point = 1,
+ /// LineString type (FdoILineString).
FdoGeometryType_LineString = 2,
+ /// Polygon type (FdoIPolygon).
FdoGeometryType_Polygon = 3,
+ /// MultiPoint type (FdoIMultiPoint).
FdoGeometryType_MultiPoint = 4,
+ /// MultiLineString type (FdoIMultiLineString).
FdoGeometryType_MultiLineString = 5,
+ /// MultiPolygon type (FdoIMultiPolygon).
FdoGeometryType_MultiPolygon = 6,
+ /// MultiGeometry type (FdoIMultiGeometry).
FdoGeometryType_MultiGeometry = 7,
+ /// CurveString type (FdoICurveString).
FdoGeometryType_CurveString = 10,
+ /// CurvePolygon type (FdoICurvePolygon).
FdoGeometryType_CurvePolygon = 11,
+ /// MultiCurveString type (FdoIMultiCurveString).
FdoGeometryType_MultiCurveString = 12,
+ /// MultiCurvePolygon type (FdoIMultiCurvePolygon).
FdoGeometryType_MultiCurvePolygon = 13
#ifdef __cplusplus
@@ -91,32 +78,27 @@
#ifdef __cplusplus
+ /// \ingroup (enums)
/// \brief
/// Enumeration for components of Geometry.
///
/// \remarks
/// This enumeration applies to certain helper types that are used to compose other types which derive from FdoIGeometry.
- ///
- /// \param FdoGeometryComponentType_LinearRing
- /// LinearRing type (FdoILinearRing).
- /// \param FdoGeometryComponentType_CircularArcSegment
- /// CircularArcSegment type (FdoICircularArcSegment).
- /// \param FdoGeometryComponentType_LineStringSegment
- /// LineStringSegment type (FdoILineStringSegment).
- /// \param FdoGeometryComponentType_Ring
- /// Ring type (FdoIRing).
- ///
enum FdoGeometryComponentType
#else
typedef enum
#endif
{
+ /// LinearRing type (FdoILinearRing).
FdoGeometryComponentType_LinearRing = 129,
+ /// CircularArcSegment type (FdoICircularArcSegment).
FdoGeometryComponentType_CircularArcSegment = 130,
+ /// LineStringSegment type (FdoILineStringSegment).
FdoGeometryComponentType_LineStringSegment = 131,
+ /// Ring type (FdoIRing).
FdoGeometryComponentType_Ring = 132
#ifdef __cplusplus
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/IStreamReader.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/IStreamReader.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/IStreamReader.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -25,6 +25,7 @@
#include <Common/Std.h>
+/// \ingroup (enums)
/// \brief
/// Enumeration for datatypes used by stream readers.
enum FdoStreamReaderType {
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/ByteStreamReader.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/ByteStreamReader.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/ByteStreamReader.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -57,6 +57,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoIoByteStreamReaderP is a FdoPtr on FdoIoByteStreamReader, provided for convenience.
typedef FdoPtr<FdoIoByteStreamReader> FdoIoByteStreamReaderP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/FileStream.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/FileStream.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/FileStream.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -64,9 +64,9 @@
FDO_API_COMMON virtual FdoBoolean CanRead();
FDO_API_COMMON virtual FdoBoolean CanWrite();
FDO_API_COMMON virtual FdoBoolean HasContext();
-
+
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Default constructor to satisfy Linux
FdoIoFileStream() {}
FdoIoFileStream(FdoString* fileName, FdoString* accessModes );
@@ -99,6 +99,7 @@
FdoBoolean mbTextMode;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoIoFileStreamP is a FdoPtr on FdoIoFileStream, provided for convenience.
typedef FdoPtr<FdoIoFileStream> FdoIoFileStreamP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/MemoryStream.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/MemoryStream.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/MemoryStream.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -92,6 +92,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoIoMemoryStreamP is a FdoPtr on FdoIoMemoryStream, provided for convenience.
typedef FdoPtr<FdoIoMemoryStream> FdoIoMemoryStreamP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/Stream.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/Stream.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/Stream.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -67,7 +67,7 @@
/// reads the number of bytes from the given stream, and writes them
/// to this stream.
///
- /// \param buffer
+ /// \param stream
/// Input write from this buffer
/// \param count
/// Input the maximum number of bytes to read and write.
@@ -83,7 +83,7 @@
/// longer than the current stream length then the stream's length
/// is not changed.
///
- FDO_API_COMMON virtual void SetLength( FdoInt64 ) = 0;
+ FDO_API_COMMON virtual void SetLength( FdoInt64 length) = 0;
/// \brief
/// gets the current length of the stream.
@@ -162,6 +162,7 @@
protected:
};
+/// \ingroup (typedefs)
/// \brief
/// FdoIoStreamP is a FdoPtr on FdoIoStream, provided for convenience.
typedef FdoPtr<FdoIoStream> FdoIoStreamP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/TextReader.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/TextReader.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/TextReader.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -74,6 +74,7 @@
FdoIoStreamP mStream;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoIoTextReaderP is a FdoPtr on FdoIoTextReader, provided for convenience.
typedef FdoPtr<FdoIoTextReader> FdoIoTextReaderP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/TextWriter.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/TextWriter.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Io/TextWriter.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -92,6 +92,7 @@
FdoIoStreamP mStream;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoIoTextWriterP is a FdoPtr on FdoIoTextWriter, provided for convenience.
typedef FdoPtr<FdoIoTextWriter> FdoIoTextWriterP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/NamedCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/NamedCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/NamedCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -95,31 +95,31 @@
///
virtual OBJ* FindItem(const wchar_t* name) const
{
- /// trigger the building of a map when the collection reaches the threshold size.
+ // trigger the building of a map when the collection reaches the threshold size.
((FdoNamedCollection<OBJ,EXC>*) this)->InitMap();
OBJ* obj = NULL;
if ( mpNameMap ) {
- /// Accessing the map is faster for large collections, so use it if built.
+ // Accessing the map is faster for large collections, so use it if built.
obj = GetMap(name);
- /// If the object name can't be modified then we're done.
- /// Otherwise, there's a chance the object name was modified,
- /// meaning that it can be in the collection but not the map,
- /// or in the wrong place in the map.
+ // If the object name can't be modified then we're done.
+ // Otherwise, there's a chance the object name was modified,
+ // meaning that it can be in the collection but not the map,
+ // or in the wrong place in the map.
if ( (obj != NULL) && !obj->CanSetName() )
return(obj);
- /// If the found object's name is the same as the given name
- /// then we're done. Otherwise, this object's name has changed
- /// and a linear search is needed to find the requested object.
+ // If the found object's name is the same as the given name
+ // then we're done. Otherwise, this object's name has changed
+ // and a linear search is needed to find the requested object.
if ( (obj != NULL) && (Compare(obj->GetName(), name) != 0) )
FDO_SAFE_RELEASE( obj );
}
if ( obj == NULL ) {
- /// No map so do linear search.
+ // No map so do linear search.
for ( FdoInt32 i = 0; i < FdoCollection<OBJ, EXC>::GetCount(); i++ ) {
OBJ* obj = GetItem(i);
@@ -148,15 +148,15 @@
{
CheckDuplicate( value, index );
- /// Remove the old item from the map
+ // Remove the old item from the map
if ( mpNameMap )
RemoveMapAt(index);
- /// Add the new item to the map
+ // Add the new item to the map
if ( mpNameMap && value )
InsertMap( value );
- /// Set the new item in the collection.
+ // Set the new item in the collection.
FdoCollection<OBJ,EXC>::SetItem(index, value);
}
@@ -173,12 +173,12 @@
{
CheckDuplicate( value, -1 );
- /// Insert the new item in the map
+ // Insert the new item in the map
if ( mpNameMap && value ) {
InsertMap(value);
}
- /// add it to the list.
+ // add it to the list.
return( FdoCollection<OBJ,EXC>::Add(value) );
}
@@ -187,8 +187,8 @@
/// Items following the insertion point are moved down to accommodate the new item.
/// Throws an invalid argument exception if the specified index is out of range.
///
- /// \param index
- /// Input index
+ /// \param item
+ /// Input item
/// \param value
/// Input value
///
@@ -199,12 +199,12 @@
{
CheckDuplicate( value, -1 );
- /// Insert the new item in the map
+ // Insert the new item in the map
if ( mpNameMap ) {
InsertMap(value);
}
- /// Insert it in the list
+ // Insert it in the list
return( FdoCollection<OBJ,EXC>::Insert(item, value) );
}
@@ -216,13 +216,13 @@
///
virtual void Clear()
{
- /// Clear the map
+ // Clear the map
if (mpNameMap ) {
delete mpNameMap;
mpNameMap = NULL;
}
- /// Clear the list
+ // Clear the list
FdoCollection<OBJ,EXC>::Clear();
}
@@ -237,11 +237,11 @@
///
virtual void Remove(const OBJ* value)
{
- /// Remove the item from the map.
+ // Remove the item from the map.
if ( mpNameMap )
RemoveMap( value );
- /// Remove it from the list
+ // Remove it from the list
FdoCollection<OBJ,EXC>::Remove(value);
}
@@ -256,11 +256,11 @@
///
virtual void RemoveAt(FdoInt32 index)
{
- /// Remove the item from the map.
+ // Remove the item from the map.
if ( mpNameMap )
RemoveMapAt(index);
- /// Remove it from the list
+ // Remove it from the list
FdoCollection<OBJ,EXC>::RemoveAt(index);
}
@@ -275,12 +275,12 @@
///
virtual bool Contains(const OBJ* value) const
{
- /// trigger the building of a map when the collection reaches the threshold size.
+ // trigger the building of a map when the collection reaches the threshold size.
((FdoNamedCollection<OBJ,EXC>*) this)->InitMap();
if (mpNameMap )
{
- /// If map is built, use it since it is faster.
+ // If map is built, use it since it is faster.
FdoPtr <FdoIDisposable> temp = GetMap (((OBJ*)value)->GetName());
bool ret = (temp != NULL);
return (ret);
@@ -379,7 +379,7 @@
if ( mbCaseSensitive )
return ( wcscmp(str1, str2) );
- /// Try case-insensitive comparison.
+ // Try case-insensitive comparison.
#ifdef _WIN32
return ( _wcsicmp(str1, str2) );
#else
@@ -410,11 +410,11 @@
private:
void InitMap()
{
- /// Build the map if not already built and the collection has hit the threshold
+ // Build the map if not already built and the collection has hit the threshold
if ( !mpNameMap && ( FdoCollection <OBJ, EXC>::GetCount() > FDO_COLL_MAP_THRESHOLD ) ) {
mpNameMap = new std::map<FdoStringP,OBJ*>();
- /// Put all the current elements into the map
+ // Put all the current elements into the map
for ( FdoInt32 i = (FdoCollection <OBJ, EXC>::GetCount() - 1); i >= 0; i-- )
InsertMap( FdoPtr<OBJ>(GetItem(i)) );
}
@@ -422,18 +422,18 @@
void InsertMap( OBJ* value ) const
{
- /// Add an element to the map. Elements are keyed by name, which may or may not be case sensitive.
- /// Case insensitive names are stored in lower case.
+ // Add an element to the map. Elements are keyed by name, which may or may not be case sensitive.
+ // Case insensitive names are stored in lower case.
if ( mbCaseSensitive )
mpNameMap->insert( std::pair<FdoStringP,OBJ*> ( value->GetName(), value ) );
else
mpNameMap->insert( std::pair<FdoStringP,OBJ*> ( FdoStringP(value->GetName()).Lower(), value ) );
}
- /// Remove the element at the specified index, from the map
+ // Remove the element at the specified index, from the map
void RemoveMapAt( FdoInt32 index )
{
- /// Remove the old item from the map
+ // Remove the old item from the map
OBJ* pItem = FdoCollection<OBJ,EXC>::GetItem(index);
if ( pItem ) {
@@ -442,17 +442,17 @@
}
}
- /// Remove the given element from the map.
+ // Remove the given element from the map.
void RemoveMap( const OBJ* value )
{
- /// handle the current case sensitivity of the element name.
+ // handle the current case sensitivity of the element name.
if ( mbCaseSensitive )
mpNameMap->erase( FdoStringP( ((OBJ*)value)->GetName() ) );
else
mpNameMap->erase( FdoStringP( ((OBJ*)value)->GetName() ).Lower() );
}
- /// Get the named element from the map. Returns NULL if element not in map.
+ // Get the named element from the map. Returns NULL if element not in map.
OBJ* GetMap( const wchar_t* name ) const
{
OBJ* pItem = NULL;
@@ -462,7 +462,7 @@
if ( mbCaseSensitive )
iter = mpNameMap->find( FdoStringP(name) );
else
- /// Case sensitive names are stored in lower case.
+ // Case sensitive names are stored in lower case.
iter = mpNameMap->find( FdoStringP(name).Lower() );
if ( iter != mpNameMap->end() ) {
@@ -475,7 +475,7 @@
bool mbCaseSensitive;
- /// A map keyed by name, to help performance of large collections.
+ // A map keyed by name, to help performance of large collections.
std::map<FdoStringP,OBJ*> *mpNameMap;
};
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Ptr.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Ptr.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Ptr.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -215,7 +215,7 @@
/// \brief
/// Less than operator
///
- /// \param lp
+ /// \param pT
/// Input the object to compare
///
/// \return
@@ -230,7 +230,7 @@
/// \brief
/// Equals operator
///
- /// \param lp
+ /// \param pT
/// Input the object to compare
///
/// \return
@@ -300,6 +300,7 @@
}
/// \cond DOXYGEN-IGNORE
+
/// Release the object and set to NULL
void Release() throw()
{
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Semaphore.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Semaphore.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Semaphore.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -20,6 +20,7 @@
//
/// \cond DOXYGEN-IGNORE
+
/// \brief
/// FdoSemaphore is a semaphore class. It is used to prevent operations
/// from happening concurrently or re-entrantly. FdoSemaphore is not currently part
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Stack.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Stack.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Stack.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -24,6 +24,7 @@
#endif
/// \cond DOXYGEN-IGNORE
+
/// \brief
/// FdoStack is an abstract template for a Stack ADT. This class is not yet
/// part of the FDOCommon API. However, doc comments have been added since it might
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/StringP.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/StringP.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/StringP.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -73,7 +73,7 @@
/// \brief
/// Copies a string from a string pointer.
///
- /// \param oValue
+ /// \param oString
/// Source string to copy from.
///
/// \return
@@ -84,7 +84,7 @@
/// \brief
/// Copies a string from a utf8 string.
///
- /// \param sValue
+ /// \param sString
/// Utf8 string to copy from.
///
/// \return
@@ -95,7 +95,7 @@
/// \brief
/// Copies a string from a unicode string.
///
- /// \param sValue
+ /// \param wString
/// Unicode string to copy from.
///
/// \return
@@ -303,7 +303,7 @@
/// \brief
/// Gets the characters to the left of the given sub-string.
///
- /// \param delimeter
+ /// \param delimiter
/// The substring.
///
/// \return
@@ -319,7 +319,7 @@
/// \brief
/// Gets the characters to the right of the given sub-string.
///
- /// \param delimeter
+ /// \param delimiter
/// The substring.
///
/// \return
@@ -441,6 +441,7 @@
FDO_API_COMMON static const wchar_t* mEmptyString;
/// \cond DOXYGEN-IGNORE
+
/// Utility function for converting from unicode to utf8.
/// returned value is allocated and must be deleted by caller.
FDO_API_COMMON static int Utf8FromUnicode(
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Vector.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Vector.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Vector.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -158,7 +158,7 @@
/// \brief
/// Adds a number to the end of this vector.
///
- /// \param src
+ /// \param value
/// Input the source collection
///
FDO_API_COMMON int Add( double value );
@@ -396,8 +396,8 @@
///
FDO_API_COMMON FdoBoolean operator<=( const FdoVectorP vec2 ) const;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// General function to do the vector comparisons.
FdoBoolean Compare( const FdoVectorP vec2, FdoBoolean lt, FdoBoolean eq, FdoBoolean gt ) const;
/// \endcond
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/Attribute.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/Attribute.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/Attribute.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -181,6 +181,7 @@
FdoStringP mValuePrefix;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlAttributeP is a FdoPtr on FdoXmlAttribute, provided for convenience.
typedef FdoPtr<FdoXmlAttribute> FdoXmlAttributeP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/AttributeCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/AttributeCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/AttributeCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -50,6 +50,7 @@
}
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlAttributeCollectionP is a FdoPtr on FdoXmlAttributeCollection, provided for convenience.
typedef FdoPtr<FdoXmlAttributeCollection> FdoXmlAttributesP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/CharDataHandler.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/CharDataHandler.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/CharDataHandler.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -67,6 +67,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlCharDataHandlerP is a FdoPtr on FdoXmlCharDataHandler, provided for convenience.
typedef FdoPtr<FdoXmlCharDataHandler> FdoXmlCharDataHandlerP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/CopyHandler.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/CopyHandler.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/CopyHandler.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -61,7 +61,7 @@
/// Input current element's Universal Resource Indicator
/// \param name
/// Input the unqualified name of the current element (doesn't include namespace)
- /// \param qname
+ /// \param qName
/// Input the qualified name of the current element(includes namespace)
/// \param atts
/// Input the attributes for the current element.
@@ -88,8 +88,8 @@
return new FdoXmlCopyHandler( writer, uri, name, qName, atts, namespaces );
}
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoXmlCopyHandler() {}
/// \endcond
@@ -147,7 +147,7 @@
/// Input the namespace URI for attribute's containing element.
/// \param name
/// Input the local name for attribute's containing element.
- /// \param qname
+ /// \param qName
/// Input the fully qualified name from attribute's containing element.
/// \param att
/// Input the attribute to check.
@@ -171,7 +171,7 @@
FdoBoolean mWroteCurrElement;
};
-
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlCopyHandlerP is a FdoPtr on FdoXmlCopyHandler, provided for convenience.
typedef FdoPtr<FdoXmlCopyHandler> FdoXmlCopyHandlerP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/Reader.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/Reader.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/Reader.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -351,6 +351,7 @@
FdoXmlSaxContextP mSaxContext;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlReaderP is a FdoPtr on FdoXmlReader, provided for convenience.
typedef FdoPtr<FdoXmlReader> FdoXmlReaderP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/SaxContext.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/SaxContext.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/SaxContext.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -62,6 +62,7 @@
FdoXmlReader* mpReader;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlSaxContextP is a FdoPtr on FdoXmlSaxContext, provided for convenience.
typedef FdoPtr<FdoXmlSaxContext> FdoXmlSaxContextP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/SaxHandler.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/SaxHandler.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/SaxHandler.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -41,7 +41,7 @@
/// Returns the SAX Handler for the document's root element. If NULL then
/// this SAX handler will handle the root element
///
- FDO_API_COMMON virtual FdoXmlSaxHandler* XmlStartDocument(FdoXmlSaxContext*);
+ FDO_API_COMMON virtual FdoXmlSaxHandler* XmlStartDocument(FdoXmlSaxContext* saxContext);
/// \brief
/// Default Sax callback that is called when the FdoXmlReader
@@ -50,7 +50,7 @@
/// \param saxContext
/// Input caller specified contextual information
///
- FDO_API_COMMON virtual void XmlEndDocument(FdoXmlSaxContext*);
+ FDO_API_COMMON virtual void XmlEndDocument(FdoXmlSaxContext* saxContext);
/// \brief
/// Default Sax callback that is called when the FdoXmlReader
@@ -71,7 +71,7 @@
/// Returns the SAX Handler for the element's sub-elements. If NULL then
/// this SAX handler will handle the sub-elements
///
- FDO_API_COMMON virtual FdoXmlSaxHandler* XmlStartElement(FdoXmlSaxContext*, FdoString*, FdoString* name, FdoString*, FdoXmlAttributeCollection*);
+ FDO_API_COMMON virtual FdoXmlSaxHandler* XmlStartElement(FdoXmlSaxContext* saxContext, FdoString* uri, FdoString* name, FdoString* qname, FdoXmlAttributeCollection* atts);
/// \brief
/// Default Sax callback that is called when the FdoXmlReader
@@ -91,7 +91,7 @@
/// cause the parse to continue. Return value is ignored if the current parse
/// is not an incremental parse ( see FdoXmlReader::Parse())
///
- FDO_API_COMMON virtual FdoBoolean XmlEndElement(FdoXmlSaxContext*, FdoString*, FdoString*, FdoString*);
+ FDO_API_COMMON virtual FdoBoolean XmlEndElement(FdoXmlSaxContext* saxContext, FdoString* uri, FdoString* name, FdoString* qname);
/// \brief
/// Default Sax callback that is called when the FdoXmlReader
@@ -105,7 +105,7 @@
/// \param chars
/// Input the next chunk of simple content
///
- FDO_API_COMMON virtual void XmlCharacters(FdoXmlSaxContext*, FdoString*);
+ FDO_API_COMMON virtual void XmlCharacters(FdoXmlSaxContext* saxContext, FdoString* chars);
};
#endif
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/SkipElementHandler.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/SkipElementHandler.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/SkipElementHandler.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -45,14 +45,14 @@
return new FdoXmlSkipElementHandler();
}
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoXmlSkipElementHandler() {}
~FdoXmlSkipElementHandler() {}
/// \endcond
};
-
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlSkipElementHandlerP is a FdoPtr on FdoXmlSkipElementHandler, provided for convenience.
typedef FdoPtr<FdoXmlSkipElementHandler> FdoXmlSkipElementHandlerP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/Writer.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/Writer.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/Writer.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,28 +31,24 @@
class FdoXmlWriter : public FdoDisposable
{
public:
- /// \brief
- /// FdoXmlWriter::LineFormat specifies whether the output XML document
- /// has line breaks or indentation.
- ///
- /// \param LineFormat_None
- /// The document is written without line breaks or element indentation.
- /// \param LineFormat_Break
- /// The document is written with a line break after:
- /// <ul>
- /// <li> every end element tag
- /// <li> every start tag for elements with complex content (sub-elements)
- /// </ul>
- /// Elements are not indented.
- /// \param LineFormat_Indent
- /// Same as LineFormat_Break, except that each element immediately following
- /// a line break is indented by a certain number of spaces. The number of
- /// spaces is the element's nesting level within the document X 3. The root
- /// element has nesting level 0.
- ///
+
+ /// \brief
+ /// Specifies whether the output XML document
+ /// has line breaks or indentation.
enum LineFormat {
+ /// The document is written without line breaks or element indentation.
LineFormat_None,
+ /// The document is written with a line break after:
+ /// <ul>
+ /// <li>every end element tag</li>
+ /// <li>every start tag for elements with complex content (sub-elements)</li>
+ /// </ul>
+ /// Elements are not indented.
LineFormat_Break,
+ /// Same as LineFormat_Break, except that each element immediately following
+ /// a line break is indented by a certain number of spaces. The number of
+ /// spaces is the element's nesting level within the document X 3. The root
+ /// element has nesting level 0.
LineFormat_Indent
};
@@ -119,7 +115,7 @@
/// \brief
/// Constructs an XML writer on a text writer
///
- /// \param reader
+ /// \param writer
/// Input the text writer.
/// \param defaultRoot
/// true: all elements written are wrapped in a default root element, named "DataStore".
@@ -148,7 +144,7 @@
/// \brief
/// Gets the underlying text writer. If a text writer was passed to this object
- /// then this text writeer is returned.
+ /// then this text writer is returned.
/// Otherwise, an auto-generated text writer is returned (a text writer
/// wrapped around the file name or stream that was passed to this object)
///
@@ -244,10 +240,13 @@
/// Writes arbitrary bytes to the XML Writer. Caller is responsible
/// for ensuring that the text does not introduce any errors into the
/// XML document.
+ ///
+ /// \param bytes
+ /// Input bytes to write.
+ ///
+ /// \param count
+ /// Input count of bytes to write.
///
- /// \param characters
- /// Input characters to write.
- ///
FDO_API_COMMON void WriteBytes( FdoByte* bytes, FdoSize count );
/// \brief
@@ -296,7 +295,7 @@
///
/// \param uri
/// Input the URI corresponding to an element.
- /// \param uri
+ /// \param localName
/// Input the local name corresponding to an element.
/// \param isElement
/// Input a boolean flag indicating that the URI corresponds to an element.
@@ -332,17 +331,17 @@
return mName;
}
- /// returns true if this element declares any namespaces.
+ /// returns true if this element declares any namespaces.
bool GetHasNsDecl();
- /// set an attribute value for this element.
+ /// set an attribute value for this element.
void SetAttribute( FdoString* attributeName, FdoString* attributeValue );
- /// Flush all the attributes to the output document
+ /// Flush all the attributes to the output document
void FlushAttributes( FdoIoTextWriterP pWriter );
- /// Generates fully qualified name for the given element from
- /// namespace declarations in this element.
+ /// Generates fully qualified name for the given element from
+ /// namespace declarations in this element.
FdoStringP UriToQName( FdoString* uri, FdoString* localName, FdoBoolean isElement );
static FdoStringP EncodeValue ( FdoStringP value );
@@ -368,8 +367,8 @@
public:
static ElementStack* Create() {return new ElementStack();}
- /// Generates fully qualified name for the given element or attribute from
- /// namespace declarations in the stacked elements.
+ /// Generates fully qualified name for the given element or attribute from
+ /// namespace declarations in the stacked elements.
FdoStringP UriToQName( FdoString* uri, FdoString* localName, FdoBoolean isElement );
protected:
@@ -417,6 +416,7 @@
FdoSize mCharWritten;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlWriterP is a FdoPtr on FdoXmlWriter, provided for convenience.
typedef FdoPtr<FdoXmlWriter> FdoXmlWriterP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/XmlException.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/XmlException.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xml/XmlException.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -30,8 +30,8 @@
/// FDO XML package
class FdoXmlException : public FdoException
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoXmlException.
///
@@ -95,6 +95,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlExceptionP is a FdoPtr on FdoXmlException, provided for convenience.
typedef FdoPtr<FdoXmlException> FdoXmlExceptionP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xsl/Transformer.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xsl/Transformer.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Common/Xsl/Transformer.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -140,8 +140,8 @@
///
FDO_API_COMMON virtual void Transform() = 0;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoXslTransformer(
FdoXmlReader* inDoc = NULL,
FdoXmlReader* stylesheet = NULL,
@@ -165,6 +165,7 @@
FdoIoTextWriterP mLog;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXslTransformerP is a FdoPtr on FdoXslTransformer, provided for convenience.
typedef FdoPtr<FdoXslTransformer> FdoXslTransformerP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ClientServiceException.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ClientServiceException.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ClientServiceException.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -35,8 +35,8 @@
/// calling applications. Derives from base FdoException class.
class FdoClientServiceException : public FdoException
{
-protected:
/// \cond DOXYGEN-IGNORE
+protected:
/// Constructs a default instance of a FdoClientServiceException.
FdoClientServiceException(void);
@@ -52,9 +52,6 @@
/// \brief
/// Default destructor for FdoClientServiceException.
///
- /// \param void
- /// Void.
- ///
/// \return
/// Returns nothing.
///
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ConnectionManager.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ConnectionManager.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ConnectionManager.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -55,8 +55,8 @@
///
friend class FdoFeatureAccessManager;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of a FdoProviderRegistry object.
FdoConnectionManager();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/Provider.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/Provider.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/Provider.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -41,8 +41,8 @@
friend class FdoRegistryUtility;
friend class FdoProviderCollection;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of a FdoProvider.
FdoProvider();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -39,8 +39,8 @@
/// lifespan of FdoProviderCollection
friend class FdoProviderRegistry;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of a FdoProviderCollection.
FdoProviderCollection();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderNameTokens.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderNameTokens.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderNameTokens.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -41,7 +41,7 @@
/// The name is usually of the form "[Company].[Provider].[Version]",
/// e.g. "Autodesk.Oracle.3.2".
///
- /// \param names
+ /// \param name
/// Input the provider name to tokenize
///
/// \return
@@ -80,8 +80,8 @@
///
FDO_API FdoStringP GetLocalName() const;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoProviderNameTokens() {}
FdoProviderNameTokens(FdoString* name);
@@ -242,12 +242,12 @@
///
FDO_API FdoBoolean operator<=( const FdoProviderNameTokensP name2 ) const;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoBoolean Compare( const FdoProviderNameTokensP name2 ) const;
+/// \endcond
};
-/// \endcond
#endif
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderRegistry.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderRegistry.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderRegistry.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -43,8 +43,8 @@
/// lifespan of FdoProviderRegistry.
friend class FdoFeatureAccessManager;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of a FdoProviderRegistry object.
FdoProviderRegistry();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/CommandException.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/CommandException.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/CommandException.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -111,6 +111,7 @@
FDO_API static FdoCommandException* Create(FdoString* message, FdoException* cause);
};
+/// \ingroup (typedefs)
/// \brief
/// FdoCommandExceptionP is a FdoPtr on FdoCommandException, provided for convenience.
typedef FdoPtr<FdoCommandException> FdoCommandExceptionP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/CommandType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/CommandType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/CommandType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,170 +23,11 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoCommandType enumeration defines the list of abstract commands a feature
/// provider can support.
-/// <param name="FdoCommandType_Select">
-/// Represents the Select command
-/// </param>
-/// <param name="FdoCommandType_Insert">
-/// Represents the Insert command
-/// </param>
-/// <param name="FdoCommandType_Delete">
-/// Represents the Delete command
-/// </param>
-/// <param name="FdoCommandType_Update">
-/// Represents the Update command
-/// </param>
-/// <param name="FdoCommandType_DescribeSchema">
-/// Represents the DescribeSchema command
-/// </param>
-/// <param name="FdoCommandType_DescribeSchemaMapping">
-/// Represents the DescribeSchemaMapping command
-/// </param>
-/// <param name="FdoCommandType_ApplySchema">
-/// Represents the ApplySchema command.
-/// </param>
-/// <param name="FdoCommandType_DestroySchema">
-/// Represents the DestroySchema command.
-/// </param>
-/// <param name="FdoCommandType_ActivateSpatialContext">
-/// Represents the ActivateSpatialContext command.
-/// </param>
-/// <param name="FdoCommandType_CreateSpatialContext">
-/// Represents the CreateSpatialContext command.
-/// </param>
-/// <param name="FdoCommandType_DestroySpatialContext">
-/// Represents the DestroySpatialContext command.
-/// </param>
-/// <param name="FdoCommandType_GetSpatialContexts">
-/// Represents the GetSpatialContexts command.
-/// </param>
-/// <param name="FdoCommandType_CreateMeasureUnit">
-/// Represents the CreateMeasureUnit command.
-/// </param>
-/// <param name="FdoCommandType_DestroyMeasureUnit">
-/// Represents the DestroyMeasureUnit command.
-/// </param>
-/// <param name="FdoCommandType_GetMeasureUnits">
-/// Represents the GetMeasureUnits command.
-/// </param>
-/// <param name="FdoCommandType_SQLCommand">
-/// Represents the SQLCommand command.
-/// </param>
-/// <param name="FdoCommandType_AcquireLock">
-/// Represents the AcquireLock command.
-/// </param>
-/// <param name="FdoCommandType_GetLockInfo">
-/// Represents the GetLockInfo command.
-/// </param>
-/// <param name="FdoCommandType_GetLockedObjects">
-/// Represents the GetLockedObjects command.
-/// </param>
-/// <param name="FdoCommandType_GetLockOwners">
-/// Represents the GetLockOwners command.
-/// </param>
-/// <param name="FdoCommandType_ReleaseLock">
-/// Represents the ReleaseLock command.
-/// </param>
-/// <param name="FdoCommandType_ActivateLongTransaction">
-/// Represents the ActivateLongTransaction command.
-/// </param>
-/// <param name="FdoCommandType_CommitLongTransaction">
-/// Represents the CommitLongTransaction command.
-/// </param>
-/// <param name="FdoCommandType_CreateLongTransaction">
-/// Represents the CreateLongTransaction command.
-/// </param>
-/// <param name="FdoCommandType_GetLongTransactions">
-/// Represents the GetLongTransactions command.
-/// </param>
-/// <param name="FdoCommandType_FreezeLongTransaction">
-/// Represents the FreezeLongTransaction command.
-/// </param>
-/// <param name="FdoCommandType_RollbackLongTransaction">
-/// Represents the RollbackLongTransaction command.
-/// </param>
-/// <param name="FdoCommandType_ActivateLongTransactionCheckpoint">
-/// Represents the ActivateLongTransactionCheckpoint command.
-/// </param>
-/// <param name="FdoCommandType_CreateLongTransactionCheckpoint">
-/// Represents the CreateLongTransactionCheckpoint command.
-/// </param>
-/// <param name="FdoCommandType_GetLongTransactionCheckpoints">
-/// Represents the GetLongTransactionCheckpoints command.
-/// </param>
-/// <param name="FdoCommandType_RollbackLongTransactionCheckpoint">
-/// Represents the RollbackLongTransactionCheckpoint command.
-/// </param>
-/// <param name="FdoCommandType_ChangeLongTransactionPrivileges">
-/// Represents the ChangeLongTransactionPrivileges command.
-/// </param>
-/// <param name="FdoCommandType_GetLongTransactionPrivileges">
-/// Represents the GetLongTransactionPrivileges command.
-/// </param>
-/// <param name="FdoCommandType_ChangeLongTransactionSet">
-/// Represents the ChangeLongTransactionSet command.
-/// </param>
-/// <param name="FdoCommandType_GetLongTransactionsInSet">
-/// Represents the GetLongTransactionsInSet command.
-/// </param>
-/// <param name="FdoCommandType_FirstProviderCommand">
-/// Represents the index of the first provider specific command.
-/// </param>
-/// <param name="FdoCommandType_SelectAggregates">
-/// Represents the SelectAggregate command.
-/// </param>
-/// <param name="(See Description note)">
-/// \note
-/// The following parameters are not supported in this release.
-/// They are provided here for informational use only. OSGeo
-/// reserves the right to change the software related to the content herein.
-/// </param>
-/// <param name="FdoCommandType_NetworkShortestPath">
-/// Represents the NetworkShortestPath command (see <b>Note</b>).
-/// </param>
-/// <param name="FdoCommandType_NetworkAllPaths">
-/// Represents the NetworkAllPaths command (see <b>Note</b>).
-/// </param>
-/// <param name="FdoCommandType_NetworkReachableNodes">
-/// Represents the NetworkReachableNodes command (see <b>Note</b>).
-/// </param>
-/// <param name="FdoCommandType_NetworkReachingNodes">
-/// Represents the NetworkReachingNodes command (see <b>Note</b>).
-/// </param>
-/// <param name="FdoCommandType_NetworkNearestNeighbors">
-/// Represents the NetworkNearestNeighbors command (see <b>Note</b>).
-/// </param>
-/// <param name="FdoCommandType_NetworkWithinCost">
-/// Represents the NetworkWithinCost command (see <b>Note</b>).
-/// </param>
-/// <param name="FdoCommandType_NetworkTSP">
-/// Represents the NetworkTSP command (see <b>Note</b>).
-/// </param>
-/// <param name="FdoCommandType_ActivateTopologyArea">
-/// Represents the ActivateTopologyArea command (see <b>Note</b>).
-/// </param>
-/// <param name="FdoCommandType_DeactivateTopologyArea">
-/// Represents the DeactivateTopologyArea command (see <b>Note</b>).
-/// </param>
-/// <param name="FdoCommandType_ActivateTopologyInCommandResult">
-/// Represents the ActivateTopologyInCommandResult command (see <b>Note</b>).
-/// </param>
-/// <param name="FdoCommandType_DeactivateTopologyInCommandResults">
-/// Represents the DeactivateTopologyInCommandResults command (see <b>Note</b>).
-/// </param>
-/// <param name="FdoCommandType_CreateDataStore">
-/// Represents the CreateDataStore command.
-/// </param>
-/// <param name="FdoCommandType_DestroyDataStore">
-/// Represents the DestroyDataStore command.
-/// </param>
-/// <param name="FdoCommandType_ListDataStores">
-/// Represents the ListDataStores command.
-/// </param>
-
-enum FdoCommandType{
+enum FdoCommandType {
/// Represents the Select Command.
FdoCommandType_Select,
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/IdentifierCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/IdentifierCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/IdentifierCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,8 +31,8 @@
/// The FdoIdentifierCollection class represents a collection of FdoIdentifier objects.
class FdoIdentifierCollection : public FdoCollection<FdoIdentifier, FdoCommandException>
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
virtual void Dispose();
/// \endcond
@@ -96,33 +96,33 @@
///
FDO_API FdoIdentifier* FindItem(const wchar_t* name)
{
- /// trigger the building of a map when the collection reaches the threshold size.
+ // trigger the building of a map when the collection reaches the threshold size.
((FdoIdentifierCollection*) this)->InitMap();
FdoIdentifier* obj = NULL;
if ( mpNameMap ) {
- /// Accessing the map is faster for large collections, so use it if built.
+ // Accessing the map is faster for large collections, so use it if built.
obj = GetMap(name);
- /// If the object name can't be modified then we're done.
- /// Otherwise, there's a chance the object name was modified,
- /// meaning that it can be in the collection but not the map,
- /// or in the wrong place in the map.
+ // If the object name can't be modified then we're done.
+ // Otherwise, there's a chance the object name was modified,
+ // meaning that it can be in the collection but not the map,
+ // or in the wrong place in the map.
/* FdoIdentifier supports SetText() so we have to assume the text might have changed
if ( (obj != NULL) && !obj->CanSetName() )
return(obj);
*/
- /// If the found object's name is the same as the given name
- /// then we're done. Otherwise, this object's name has changed
- /// and a linear search is needed to find the requested object.
+ // If the found object's name is the same as the given name
+ // then we're done. Otherwise, this object's name has changed
+ // and a linear search is needed to find the requested object.
if ( (obj != NULL) && (Compare(obj->GetText(), name) != 0) )
FDO_SAFE_RELEASE( obj );
}
if ( obj == NULL ) {
- /// No map so do linear search.
+ // No map so do linear search.
for ( FdoInt32 i = 0; i < FdoCollection<FdoIdentifier, FdoCommandException>::GetCount(); i++ ) {
FdoIdentifier* obj = GetItem(i);
@@ -151,15 +151,15 @@
{
CheckDuplicate( value, index );
- /// Remove the old item from the map
+ // Remove the old item from the map
if ( mpNameMap )
RemoveMapAt(index);
- /// Add the new item to the map
+ // Add the new item to the map
if ( mpNameMap && value )
InsertMap( value );
- /// Set the new item in the collection.
+ // Set the new item in the collection.
FdoCollection<FdoIdentifier, FdoCommandException>::SetItem(index, value);
}
@@ -176,12 +176,12 @@
{
CheckDuplicate( value, -1 );
- /// Insert the new item in the map
+ // Insert the new item in the map
if ( mpNameMap && value ) {
InsertMap(value);
}
- /// add it to the list.
+ // add it to the list.
return( FdoCollection<FdoIdentifier, FdoCommandException>::Add(value) );
}
@@ -190,7 +190,7 @@
/// Items following the insertion point are moved down to accommodate the new item.
/// Throws an invalid argument exception if the specified index is out of range.
///
- /// \param index
+ /// \param item
/// Input index
/// \param value
/// Input value
@@ -202,12 +202,12 @@
{
CheckDuplicate( value, -1 );
- /// Insert the new item in the map
+ // Insert the new item in the map
if ( mpNameMap ) {
InsertMap(value);
}
- /// Insert it in the list
+ // Insert it in the list
return( FdoCollection<FdoIdentifier, FdoCommandException>::Insert(item, value) );
}
@@ -219,13 +219,13 @@
///
virtual void Clear()
{
- /// Clear the map
+ // Clear the map
if (mpNameMap ) {
delete mpNameMap;
mpNameMap = NULL;
}
- /// Clear the list
+ // Clear the list
FdoCollection<FdoIdentifier, FdoCommandException>::Clear();
}
@@ -240,11 +240,11 @@
///
virtual void Remove(const FdoIdentifier* value)
{
- /// Remove the item from the map.
+ // Remove the item from the map.
if ( mpNameMap )
RemoveMap( value );
- /// Remove it from the list
+ // Remove it from the list
FdoCollection<FdoIdentifier, FdoCommandException>::Remove(value);
}
@@ -259,11 +259,11 @@
///
virtual void RemoveAt(FdoInt32 index)
{
- /// Remove the item from the map.
+ // Remove the item from the map.
if ( mpNameMap )
RemoveMapAt(index);
- /// Remove it from the list
+ // Remove it from the list
FdoCollection<FdoIdentifier, FdoCommandException>::RemoveAt(index);
}
@@ -278,12 +278,12 @@
///
virtual bool Contains(const FdoIdentifier* value)
{
- /// trigger the building of a map when the collection reaches the threshold size.
+ // trigger the building of a map when the collection reaches the threshold size.
((FdoIdentifierCollection*) this)->InitMap();
if (mpNameMap )
{
- /// If map is built, use it since it is faster.
+ // If map is built, use it since it is faster.
FdoPtr <FdoIDisposable> temp = GetMap (((FdoIdentifier*)value)->GetText());
bool ret = (temp != NULL);
return (ret);
@@ -381,7 +381,7 @@
if ( mbCaseSensitive )
return ( wcscmp(str1, str2) );
- /// Try case-insensitive comparison.
+ // Try case-insensitive comparison.
#ifdef _WIN32
return ( _wcsicmp(str1, str2) );
#else
@@ -412,11 +412,11 @@
private:
void InitMap()
{
- /// Build the map if not already built and the collection has hit the threshold
+ // Build the map if not already built and the collection has hit the threshold
if ( !mpNameMap && ( FdoCollection<FdoIdentifier, FdoCommandException>::GetCount() > FDO_COLL_MAP_THRESHOLD ) ) {
mpNameMap = new std::map<FdoStringP,FdoIdentifier*>();
- /// Put all the current elements into the map
+ // Put all the current elements into the map
for ( FdoInt32 i = (FdoCollection<FdoIdentifier, FdoCommandException>::GetCount() - 1); i >= 0; i-- )
InsertMap( FdoPtr<FdoIdentifier>(GetItem(i)) );
}
@@ -424,18 +424,18 @@
void InsertMap( FdoIdentifier* value ) const
{
- /// Add an element to the map. Elements are keyed by name, which may or may not be case sensitive.
- /// Case insensitive names are stored in lower case.
+ // Add an element to the map. Elements are keyed by name, which may or may not be case sensitive.
+ // Case insensitive names are stored in lower case.
if ( mbCaseSensitive )
mpNameMap->insert( std::pair<FdoStringP,FdoIdentifier*> ( value->GetText(), value ) );
else
mpNameMap->insert( std::pair<FdoStringP,FdoIdentifier*> ( FdoStringP(value->GetText()).Lower(), value ) );
}
- /// Remove the element at the specified index, from the map
+ // Remove the element at the specified index, from the map
void RemoveMapAt( FdoInt32 index )
{
- /// Remove the old item from the map
+ // Remove the old item from the map
FdoIdentifier* pItem = FdoCollection<FdoIdentifier, FdoCommandException>::GetItem(index);
if ( pItem ) {
@@ -444,17 +444,17 @@
}
}
- /// Remove the given element from the map.
+ // Remove the given element from the map.
void RemoveMap( const FdoIdentifier* value )
{
- /// handle the current case sensitivity of the element name.
+ // handle the current case sensitivity of the element name.
if ( mbCaseSensitive )
mpNameMap->erase( FdoStringP( ((FdoIdentifier*)value)->GetText() ) );
else
mpNameMap->erase( FdoStringP( ((FdoIdentifier*)value)->GetText() ).Lower() );
}
- /// Get the named element from the map. Returns NULL if element not in map.
+ // Get the named element from the map. Returns NULL if element not in map.
FdoIdentifier* GetMap( const wchar_t* name ) const
{
FdoIdentifier* pItem = NULL;
@@ -464,7 +464,7 @@
if ( mbCaseSensitive )
iter = mpNameMap->find( FdoStringP(name) );
else
- /// Case sensitive names are stored in lower case.
+ // Case sensitive names are stored in lower case.
iter = mpNameMap->find( FdoStringP(name).Lower() );
if ( iter != mpNameMap->end() ) {
@@ -477,7 +477,7 @@
bool mbCaseSensitive;
- /// A map keyed by name, to help performance of large collections.
+ // A map keyed by name, to help performance of large collections.
std::map<FdoStringP,FdoIdentifier*> *mpNameMap;
};
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/ConflictType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/ConflictType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/ConflictType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,31 +23,26 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoConflictType enumeration defines conflict types required to
/// identify the lock type of a conflict reported with the lock conflict reader.
-/// <param name="FdoConflictType_LockConflict">
-/// Identifies a reported conflict
-/// in the lock conflict reader as a lock conflict. A conflict represents a
-/// lock conflict if an object the user requests to be locked is already locked
-/// by a different user.
-/// </param>
-/// <param name="FdoConflictType_VersionConflict">
-/// Identifies a reported conflict
-/// in the lock conflict reader as a version conflict. A conflict represents a
-/// version conflict if an object the user requests to be locked has already been
-/// versioned.
-/// </param>
-/// <param name="FdoConflictType_Unsupported">
-/// Indicates that an unsupported or
-/// unknown conflict type has been encountered.
-/// </param>
enum FdoConflictType
{
+ /// Identifies a reported conflict
+ /// in the lock conflict reader as a lock conflict. A conflict represents a
+ /// lock conflict if an object the user requests to be locked is already locked
+ /// by a different user.
FdoConflictType_LockConflict,
+ /// Identifies a reported conflict
+ /// in the lock conflict reader as a version conflict. A conflict represents a
+ /// version conflict if an object the user requests to be locked has already been
+ /// versioned.
FdoConflictType_VersionConflict,
+ /// Indicates that an unsupported or
+ /// unknown conflict type has been encountered.
FdoConflictType_Unsupported
};
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockStrategy.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockStrategy.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockStrategy.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,17 +23,14 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoLockStrategy enumeration defines how lock acquisition should proceed.
-/// <param name="FdoLockStrategy_All">
-/// Declares that either all of the locks must be acquired or none should be acquired.
-/// </param>
-/// <param name="FdoLockStrategy_Partial">
-/// Declares that all of the locks that can be acquired should be acquired.
-/// </param>
enum FdoLockStrategy
{
+ /// Declares that either all of the locks must be acquired or none should be acquired.
FdoLockStrategy_All,
+ /// Declares that all of the locks that can be acquired should be acquired.
FdoLockStrategy_Partial
};
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,6 +23,7 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoLockType enumeration defines lock types. The lock type for
/// a locked object indicates a user's access privileges (including the user
@@ -33,65 +34,50 @@
/// specified value indicates the lock type to be used when applying a lock on
/// an object. With the command FdoIGetLockInfo, the enumaration values are used
/// to report lock types back to the user.
+/// </p>
/// <p>
/// The enumeration contains some special lock types (FdoLockType_None and FdoLockType_Unsupported)
/// that are used only when reporting lock type information.
/// These special lock types cannot be used to specify a lock type to be applied
/// to an object.
-/// <param name="FdoLockType_None">
-/// Indicates that an object is unlocked.
-/// This type cannot be used with the commands FdoIAcquireLock and FdoISelect.
-/// </param>
-/// <param name="FdoLockType_Unsupported">
-/// Indicates that an unsupported lock
-/// type has been encountered. This type cannot be used with the commands
-/// FdoIAcquireLock and FdoISelect.
-/// </param>
-/// <param name="FdoLockType_Shared">
-/// Indicates a shared lock type. The type can
-/// be used with the commands FdoIAcquireLock and FdoISelect.
-/// </param>
-/// <param name="FdoLockType_Transaction">
-/// Indicates that a transaction lock
-/// should be applied on an object. This type can be used with the commands
-/// FdoIAcquireLock and FdoISelect.
-/// </param>
-/// <param name="FdoLockType_Exclusive">
-/// Indicates that only this user can modify
-/// this object. In a long transaction situation, any user can modify the object in any
-/// other long transaction, including the root long transaction if it is not the current
-/// long transaction.
-/// <P>
-/// The type can be used with the commands FdoIAcquireLock and FdoISelect.
-/// </param>
-/// <param name="FdoLockType_LongTransactionExclusive">
-/// Indicates that only this user can
-/// modify this object in the long transaction containing the object or any long
-/// transaction created as a descendent of that one. When not in a long transaction
-/// situation (for example, if only a root long transaction exists), the lock behaves
-/// like an Exclusive lock.
-/// <P>
-/// The type can be used with the commands FdoIAcquireLock and FdoISelect.
-/// </param>
-/// <param name="FdoLockType_AllLongTransactionExclusive">
-/// Indicates that only this user can
-/// modify this object in this long transaction. No user, not even the user locking the object,
-/// can modify the object in any long transaction created as a descendent of the one
-/// containing the object being locked. When not in a long transaction situation (for example,
-/// if only a root long transaction exists), the lock behaves like an Exclusive lock.
-/// <P>
-/// This type can be used with the commands FdoIAcquireLock and FdoISelect.
-/// </param>
+/// </p>
enum FdoLockType
{
+ /// Indicates that an object is unlocked.
+ /// This type cannot be used with the commands FdoIAcquireLock and FdoISelect.
FdoLockType_None,
+ /// Indicates a shared lock type. The type can
+ /// be used with the commands FdoIAcquireLock and FdoISelect.
FdoLockType_Shared,
+ /// Indicates that only this user can modify
+ /// this object. In a long transaction situation, any user can modify the object in any
+ /// other long transaction, including the root long transaction if it is not the current
+ /// long transaction.
+ /// The type can be used with the commands FdoIAcquireLock and FdoISelect.
FdoLockType_Exclusive,
+ /// Indicates that a transaction lock
+ /// should be applied on an object. This type can be used with the commands
+ /// FdoIAcquireLock and FdoISelect.
FdoLockType_Transaction,
+ /// Indicates that an unsupported lock
+ /// type has been encountered. This type cannot be used with the commands
+ /// FdoIAcquireLock and FdoISelect.
FdoLockType_Unsupported,
+ /// Indicates that only this user can
+ /// modify this object in this long transaction. No user, not even the user locking the object,
+ /// can modify the object in any long transaction created as a descendent of the one
+ /// containing the object being locked. When not in a long transaction situation (for example,
+ /// if only a root long transaction exists), the lock behaves like an Exclusive lock.
+ /// This type can be used with the commands FdoIAcquireLock and FdoISelect.
FdoLockType_AllLongTransactionExclusive,
+ /// Indicates that only this user can
+ /// modify this object in the long transaction containing the object or any long
+ /// transaction created as a descendent of that one. When not in a long transaction
+ /// situation (for example, if only a root long transaction exists), the lock behaves
+ /// like an Exclusive lock.
+ /// The type can be used with the commands FdoIAcquireLock and FdoISelect.
FdoLockType_LongTransactionExclusive
};
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionConflictResolution.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionConflictResolution.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionConflictResolution.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,23 +23,13 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoLongTransactionConflictResolution enumeration defines the list of
/// available options for resolving conflict.
-/// <param name="FdoLongTransactionConflictResolution_Unresolved">
-/// Indicates that the conflict cannot be resolved.
-/// </param>
-/// <param name="FdoLongTransactionConflictResolution_Child">
-/// Indicates the data is to be kept as defined in the long transaction to be committed,
-/// overwriting the data in the long transaction's parent.
-/// </param>
-/// <param name="FdoLongTransactionConflictResolution_Parent">
-/// Indicates the data is to be kept as defined in the versions parent, discarding the data
-/// as defined in the long transaction to be committed.
-/// </param>
enum FdoLongTransactionConflictResolution
{
- //
+ /// Indicates that the conflict cannot be resolved.
FdoLongTransactionConflictResolution_Unresolved,
/// Keep the data as defined in the long transaction to be committed,
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionFreezeOperations.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionFreezeOperations.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionFreezeOperations.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,14 +23,9 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoLongTransactionFreezeOperations enumeration defines the list of available operations that can be performed by the FreezeLongTransaction command.
-/// <param name="FdoLongTransactionFreezeOperations_Freeze">
-/// Freeze the long transaction for exclusive update
-/// </param>
-/// <param name="FdoLongTransactionFreezeOperations_Thaw">
-/// Thaw the long transaction
-/// </param>
enum FdoLongTransactionFreezeOperations
{
/// Freeze the long transaction for exclusive update.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivilegeOperations.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivilegeOperations.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivilegeOperations.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,16 +23,11 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoLongTransactionPrivilegeOperations enumeration defines the list
/// of available operations that can be performed by the
/// ChangeLongTransactionPrivileges command.
-/// <param name="FdoLongTransactionPrivilegeOperations_Grant">
-/// Indicates the user is to be granted the specified privileges.
-/// </param>
-/// <param name="FdoLongTransactionPrivilegeOperations_Revoke">
-/// Indicates the specified privileges are to be revoked from the user.
-/// </param>
enum FdoLongTransactionPrivilegeOperations
{
/// Grant the user the specified privileges.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivileges.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivileges.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivileges.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,39 +23,10 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoLongTransactionPrivileges enumeration defines the long transaction
/// privilege flags.
-/// <param name="FdoLongTransactionPrivileges_Access">
-/// The access privilege is required for a user if the user needs to access
-/// a long transaction.
-/// </param>
-/// <param name="FdoLongTransactionPrivileges_Create">
-/// A user must have access and create privileges on the active long
-/// transaction if the user wants to create a new long transaction as a
-/// descendent of the active long transaction.
-/// </param>
-/// <param name="FdoLongTransactionPrivileges_Commit">
-/// A user must have access and commit privileges on a long transaction
-/// in order to commit it. In addition, the user needs access privilege to
-/// the long transaction's parent. The user also needs remove privilege on
-/// the long transaction to be committed if the operation to be executed
-/// is a commit and not a partial commit.
-/// </param>
-/// <param name="FdoLongTransactionPrivileges_Rollback">
-/// A user must have access and rollback privileges on a long transaction
-/// in order to roll it back. In addition, the user requires access
-/// privilege for each of the descendent versions involved in the operation. The user also requires the remove privilege for each of the versions involved in the operation if a rollback and not a partial rollback operation is executed.
-/// </param>
-/// <param name="FdoLongTransactionPrivileges_Remove">
-/// The long transaction privilege is required if the user should be allowed to remove the
-/// long transaction in the progress of a commit or roll back operation.
-/// </param>
-/// <param name="FdoLongTransactionPrivileges_Freeze">
-/// The user requires the access and freeze privileges on a long
-/// transaction for which the user wants to gain exclusive access to a
-/// long transaction.
-/// </param>
enum FdoLongTransactionPrivileges
{
/// The access privilege is required for a user if the user needs to access
@@ -76,7 +47,9 @@
/// A user must have access and rollback privileges on a long transaction
/// in order to roll it back. In addition, the user requires access
- /// privilege for each of the descendent versions involved in the operation. The user also requires the remove privilege for each of the versions involved in the operation if a rollback and not a partial rollback operation is executed.
+ /// privilege for each of the descendent versions involved in the operation.
+ /// The user also requires the remove privilege for each of the versions involved
+ /// in the operation if a rollback and not a partial rollback operation is executed.
FdoLongTransactionPrivileges_Rollback,
/// The privilege is required if the user should be allowed to remove the
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionSetOperations.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionSetOperations.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionSetOperations.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,18 +23,10 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoLongTransactionSetOperations enumeration defines the list of
/// available operations that can be performed by the ChangeLongTransactionSet command.
-/// <param name="FdoLongTransactionSetOperations_Add">
-/// Add the specified long transaction to the selection set.
-/// </param>
-/// <param name="FdoLongTransactionSetOperations_Remove">
-/// Remove the specified long transaction from the selection set.
-/// </param>
-/// <param name="FdoLongTransactionSetOperations_Clear">
-/// Clear the selection set.
-/// </param>
enum FdoLongTransactionSetOperations
{
/// Add the specified long transaction to the selection set.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/OrderingOption.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/OrderingOption.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/OrderingOption.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,15 +23,10 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoOrderingOption enumeration defines the list acceptable values that
/// can be specified as order by clause to the select and select aggregate commands.
-/// <param name="FdoOrderingOption_Ascending">
-/// Used for ascending option
-/// </param>
-/// <param name="FdoOrderingOption_Descending">
-/// Used for descending option
-/// </param>
enum FdoOrderingOption{
/// Used for ascending option.
FdoOrderingOption_Ascending,
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/ParameterValue.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/ParameterValue.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/ParameterValue.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -33,8 +33,8 @@
/// when a command is executed.
class FdoParameterValue : public FdoIDisposable
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of a ParameterValue.
FdoParameterValue();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValue.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValue.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValue.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -35,8 +35,8 @@
/// and the properties value.
class FdoPropertyValue : public FdoIDisposable
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoPropertyValue.
FdoPropertyValue();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValueCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValueCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValueCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -33,8 +33,8 @@
/// insert and update commands.
class FdoPropertyValueCollection : public FdoCollection<FdoPropertyValue, FdoCommandException>
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default empty instance of an FdoPropertyValueCollection.
FdoPropertyValueCollection():FdoCollection<FdoPropertyValue, FdoCommandException>()
{
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalClassMapping.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalClassMapping.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalClassMapping.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -100,6 +100,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoPhysicalClassMappingP is a FdoPtr on FdoPhysicalClassMapping, provided for convenience.
typedef FdoPtr<FdoPhysicalClassMapping> FdoPhysicalClassMappingP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMapping.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMapping.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMapping.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -141,6 +141,7 @@
);
/// \cond DOXYGEN-IGNORE
+
/// Various error reporting functions that are not yet part of the supported
/// FDO API.
/// All of them return a FdoXmlSkipElementHandler, which can be used to skip
@@ -201,6 +202,7 @@
FDO_API void SetParent(FdoPhysicalElementMapping* value);
/// \cond DOXYGEN-IGNORE
+
/// retrieves a FdoXmlSkipElementHandler for skipping an entire XML element
FDO_API FdoXmlSaxHandler* GetSkipper();
@@ -227,6 +229,7 @@
FdoStringP m_description;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoPhysicalElementMappingP is a FdoPtr on FdoPhysicalElementMapping, provided for convenience.
typedef FdoPtr<FdoPhysicalElementMapping> FdoPhysicalElementMappingP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMappingCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMappingCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMappingCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -34,8 +34,8 @@
template <class OBJ> class FdoPhysicalElementMappingCollection : public FdoNamedCollection<OBJ, FdoCommandException>
{
-protected:
/// \cond DOXYGEN-IGNORE
+protected:
FdoPhysicalElementMappingCollection() : FdoNamedCollection<OBJ, FdoCommandException>(),
m_parent(NULL)
{
@@ -54,16 +54,16 @@
{
FdoPtr<OBJ> pitem = FdoNamedCollection<OBJ, FdoCommandException>::GetItem(i);
- /// When the collection disappears, the ownership does too.
- /// So NULL out the parent. This is necessary because the
- /// parent reference within items is not refcounted to avoid
- /// circular references/memory leaks.
- ///
- /// \warning
- /// The pitem->GetParent() should always equal m_parent, but we cannot verify this
- /// because the call to pitem->GetParent() might AddRef() an item that has already
- /// been disposed. So we just NULL it out.
- ///
+ // When the collection disappears, the ownership does too.
+ // So NULL out the parent. This is necessary because the
+ // parent reference within items is not refcounted to avoid
+ // circular references/memory leaks.
+ //
+ // \warning
+ // The pitem->GetParent() should always equal m_parent, but we cannot verify this
+ // because the call to pitem->GetParent() might AddRef() an item that has already
+ // been disposed. So we just NULL it out.
+ //
pitem->SetParent(NULL);
}
}
@@ -84,15 +84,15 @@
///
virtual void SetItem(FdoInt32 index, OBJ* value)
{
- /// Verify index is in bounds.
+ // Verify index is in bounds.
if (index < FdoNamedCollection<OBJ, FdoCommandException>::GetCount() && index >= 0)
{
if (m_parent)
{
- /// Validate parentage for object to add. Membership in a
- /// collection implys parentage, and a object can only have
- /// one parent.
- ///
+ // Validate parentage for object to add. Membership in a
+ // collection implys parentage, and a object can only have
+ // one parent.
+ //
FdoPhysicalElementMappingP pparent = value->GetParent();
if (pparent && (pparent != m_parent) )
throw FdoCommandException::Create(FdoException::NLSGetMessage(FDO_NLSID(COMMANDS_7_OBJECTHASPARENT),value->GetName()));
@@ -105,10 +105,10 @@
FdoPhysicalElementMappingP pparentOldItem = pitemOld->GetParent();
if ( pparentOldItem == m_parent )
{
- /// When an object is removed from a collection, that
- /// collection's owner is no longer the object's
- /// parent.
- ///
+ // When an object is removed from a collection, that
+ // collection's owner is no longer the object's
+ // parent.
+ //
pitemOld->SetParent(NULL);
}
}
@@ -129,10 +129,10 @@
{
if (m_parent)
{
- /// Validate parentage for object to add. Membership in a
- /// collection implys parentage, and a object can only have
- /// one parent.
- ///
+ // Validate parentage for object to add. Membership in a
+ // collection implys parentage, and a object can only have
+ // one parent.
+ //
FdoPhysicalElementMappingP pparent = value->GetParent();
if (pparent && (pparent != m_parent) )
throw FdoCommandException::Create(FdoException::NLSGetMessage(FDO_NLSID(COMMANDS_7_OBJECTHASPARENT),value->GetName()));
@@ -161,10 +161,10 @@
{
if (m_parent)
{
- /// Validate parentage for object to add. Membership in a
- /// collection implys parentage, and a object can only have
- /// one parent.
- ///
+ // Validate parentage for object to add. Membership in a
+ // collection implys parentage, and a object can only have
+ // one parent.
+ //
FdoPhysicalElementMappingP pparent = value->GetParent();
if (pparent && (pparent != m_parent) )
throw FdoCommandException::Create(FdoException::NLSGetMessage(FDO_NLSID(COMMANDS_7_OBJECTHASPARENT),value->GetName()));
@@ -193,10 +193,9 @@
if ( pparent == m_parent )
{
- /// When an object is removed from a collection, that
- /// collection's owner is no longer the object's
- /// parent.
- /// //
+ // When an object is removed from a collection, that
+ // collection's owner is no longer the object's
+ // parent.
pitem->SetParent(NULL);
}
}
@@ -218,16 +217,16 @@
{
if (m_parent)
{
- /// Cast drops const
+ // Cast drops const
FdoPtr<OBJ> pitem = (OBJ*)value;
FdoPhysicalElementMappingP pparent = pitem->GetParent();
if ( pparent == m_parent )
{
- /// When an object is removed from a collection, that
- /// collection's owner is no longer the object's
- /// parent.
- ///
+ // When an object is removed from a collection, that
+ // collection's owner is no longer the object's
+ // parent.
+ //
pitem->SetParent(NULL);
}
}
@@ -254,10 +253,10 @@
if ( pparent == m_parent )
{
- /// When an object is removed from a collection, that
- /// collection's owner is no longer the object's
- /// parent.
- ///
+ // When an object is removed from a collection, that
+ // collection's owner is no longer the object's
+ // parent.
+ //
pitem->SetParent(NULL);
}
@@ -266,9 +265,9 @@
FdoNamedCollection<OBJ, FdoCommandException>::RemoveAt(index);
}
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// m_parent is a non-refcounted reference, to avoid circular references that prevent
/// elements from being freed.
FdoPhysicalElementMapping* m_parent;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalPropertyMapping.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalPropertyMapping.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalPropertyMapping.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -98,6 +98,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoPhysicalPropertyMappingP is a FdoPtr on FdoPhysicalPropertyMapping, provided for convenience.
typedef FdoPtr<FdoPhysicalPropertyMapping> FdoPhysicalPropertyMappingP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMapping.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMapping.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMapping.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -90,6 +90,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoIPhysicalSchemaMappingP is a FdoPtr on FdoIPhysicalSchemaMapping, provided for convenience.
typedef FdoPtr<FdoPhysicalSchemaMapping> FdoPhysicalSchemaMappingP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMappingCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMappingCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMappingCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -46,9 +46,6 @@
/// \brief
/// Constructs an instance of an FdoPhysicalSchemaMappingCollection .
///
- /// \param parent
- /// Input parent
- ///
/// \return
/// Returns FdoPhysicalSchemaMappingCollection
///
@@ -57,8 +54,8 @@
/// \brief
/// Gets the Schema Override set in the collection at the specified index. Throws an invalid argument exception if the index is out of range.
///
- /// \param index
- /// Input index
+ /// \param item
+ /// Input item
///
/// \return
/// Returns the Schema Override set at the specified index
@@ -108,6 +105,7 @@
);
/// \cond DOXYGEN-IGNORE
+//
/// FdoXmlDeserializable overrides for deserializing a Schema Override set collection
/// from XML. These are not exposed via the FDO API.
@@ -143,6 +141,7 @@
FdoPtr<FdoXmlSkipElementHandler> m_XmlSkipper;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoSchemaMappingsP is a FdoPtr on FdoPhysicalSchemaMappingCollection, provided for convenience.
typedef FdoPtr<FdoPhysicalSchemaMappingCollection> FdoSchemaMappingsP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/ISpatialContextReader.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/ISpatialContextReader.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/ISpatialContextReader.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -82,9 +82,6 @@
/// Gets the extent of the spatial context currently being read as a byte
/// array in FGF format.
///
- /// \param length
- /// Output the length of the returned byte array.
- ///
/// \return
/// Returns the extent as a byte array in FGF format.
///
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextExtentType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextExtentType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextExtentType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,17 +23,10 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoSpatialContextExtentType enumeration defines how the extent of
/// a context should be handled by the provider.
-/// <param name="FdoSpatialContextExtentType_Static">
-/// The spatial extent of the context is static and must be specified
-/// when the context is created.
-/// </param>
-/// <param name="FdoSpatialContextExtentType_Dynamic">
-/// The spatial extent of the context is dynamic and changes as data is
-/// added and removed from the context.
-/// </param>
enum FdoSpatialContextExtentType
{
/// The spatial extent of the context is static and must be specified
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextMismatchException.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextMismatchException.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextMismatchException.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -83,6 +83,7 @@
FDO_API static FdoSpatialContextMismatchException* Create(FdoString* message, FdoException* cause);
};
+/// \ingroup (typedefs)
/// \brief
/// FdoSpatialContextMismatchExceptionP is a FdoPtr on FdoSpatialContextMismatchException, provided for convenience.
typedef FdoPtr<FdoSpatialContextMismatchException> FdoSpatialContextMismatchExceptionP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Sql/ISQLDataReader.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Sql/ISQLDataReader.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/Sql/ISQLDataReader.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -67,7 +67,7 @@
/// to indicate if a given column is a geometric property or a data property. If the column is
/// a FdoPropertyType_DataProperty, then GetColumnType can be used to find the data type of the column.
///
- /// \param propertyName
+ /// \param columnName
/// Input the column name.
///
/// \return
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/UnitOfMeasure/BaseUnit.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/UnitOfMeasure/BaseUnit.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Commands/UnitOfMeasure/BaseUnit.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,18 +23,10 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoBaseUnit enumeration defines the well known base unit used to
/// establish a measure unit.
-/// <param name="FdoBaseUnit_None">
-/// Input no base unit
-/// </param>
-/// <param name="FdoBaseUnit_Meters">
-/// Input base unit meters
-/// </param>
-/// <param name="FdoBaseUnit_Radians">
-/// Input base unit radians
-/// </param>
enum FdoBaseUnit
{
/// Represents an unspecified base unit, it can be used to create an
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ArgumentDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ArgumentDefinition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ArgumentDefinition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,8 +31,8 @@
/// The FdoArgumentDefinition class contains metadata that describes an argument to a function.
class FdoArgumentDefinition : public FdoIDisposable
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs an instance of an FdoArgumentDefinition using the specified arguments.
FdoArgumentDefinition(FdoString* name, FdoString* description, FdoDataType dataType);
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/FunctionDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/FunctionDefinition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/FunctionDefinition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -33,8 +33,8 @@
/// The FdoFunctionDefinition class contains metadata that describes a function and its arguments.
class FdoFunctionDefinition : public FdoIDisposable
{
-protected:
/// \cond DOXYGEN-IGNORE
+protected:
/// Constructs an instance of an FdoFunctionDefinition using the specified arguments.
FdoFunctionDefinition (FdoString *name,
FdoString *description,
@@ -91,7 +91,7 @@
/// Input the name of the function.
/// \param description
/// Input a brief description.
- /// \param returnProperty Type
+ /// \param returnPropertyType
/// Input the function return property type
/// \param returnType
/// Input the function return data type (ignore it property type is not data)
@@ -144,9 +144,6 @@
/// \brief
/// Gets an array of FdoArgumentDefinition objects required for the function.
///
- /// \param length
- /// Output the number of argument definitions.
- ///
/// \return
/// Returns the list of argument definitions
///
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ISchemaCapabilities.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ISchemaCapabilities.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ISchemaCapabilities.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -73,9 +73,6 @@
/// \brief
/// Returns the maximum supported precision for a decimal data property.
///
- /// \param
- /// None.
- ///
/// \return
/// Returns the maximum supported precision for a decimal data property.
///
@@ -84,9 +81,6 @@
/// \brief
/// Returns the maximum supported scale for a decimal data property.
///
- /// \param
- /// None.
- ///
/// \return
/// Returns the maximum supported scale for a decimal data property.
///
@@ -112,9 +106,6 @@
/// Returns a string that includes all the reserved characters that cannot be
/// used for the various schema element names for the provider.
///
- /// \param
- /// None
- ///
/// \return
/// Returns a string with the reserved characters for the identified schema element.
///
@@ -186,9 +177,6 @@
/// Returns TRUE if default values can be specified for a data property
/// definition, FALSE otherwise.
///
- /// \param
- /// None
- ///
/// \return
/// Returns TRUE if default values can be specified for a data property
/// definition, FALSE otherwise.
@@ -212,6 +200,7 @@
FDO_API virtual bool SupportsInclusiveValueRangeConstraints() = 0;
/// \cond DOXYGEN-IGNORE
+
/// \brief
/// DEPRECATED: Use SupportsInheritance() instead.
/// Determines if the feature provider supports inheritance.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SchemaElementNameType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SchemaElementNameType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SchemaElementNameType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -22,24 +22,10 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoSchemaElementNameType enumeration lists all of the concrete schema name
/// types defined to address schema limitation information.
-/// <param name="FdoSchemaElementNameType_Datastore">
-/// Represents the identifier to address a data store name
-/// </param>
-/// <param name="FdoSchemaElementNameType_Schema">
-/// Represents the identifier to address a schema
-/// </param>
-/// <param name="FdoSchemaElementNameType_Class">
-/// Represents the identifier to address a class
-/// </param>
-/// <param name="FdoSchemaElementNameType_Property">
-/// Represents the identifier to address a property
-/// </param>
-/// <param name="FdoSchemaElementNameType_Description">
-/// Represents the identifier to address a description
-/// </param>
enum FdoSchemaElementNameType
{
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SignatureDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SignatureDefinition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SignatureDefinition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -59,8 +59,8 @@
FDO_API FdoDataType GetReturnType ();
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs an instance of a SignatureDefinition using the specified arguments.
FdoSignatureDefinition (FdoDataType returnType,
FdoArgumentDefinitionCollection *arguments);
@@ -127,8 +127,8 @@
FdoSignatureDefinitionCollection,
FdoSchemaException>
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs an instance of a SignatureDefinition using the specified arguments.
FdoReadOnlySignatureDefinitionCollection ();
@@ -144,7 +144,7 @@
/// \brief
/// Constructs an instance of an FdoReadOnlySignatureDefinitionCollection by providing a non-readonly collection.
///
- /// \param collection
+ /// \param col
/// Input a signature collection
///
/// \return
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ThreadCapability.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ThreadCapability.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ThreadCapability.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,26 +23,9 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoThreadCapability enumeration defines the threading capabilities of a feature provider.
-/// <param name="FdoThreadCapability_SingleThreaded">
-/// The feature provider is not thread safe.
-/// </param>
-/// <param name="FdoThreadCapability_PerConnectionThreaded">
-/// The feature provider supports a single thread per connection. Multiple concurrent threads
-/// cannot access the same connection object and only one command can be executing per
-/// connection. Multiple connections can be active concurrently as long as each is
-/// executing on its own thread.
-/// </param>
-/// <param name="FdoThreadCapability_PerCommandThreaded">
-/// The feature provider supports a single thread per command. Multiple concurrent threads
-/// cannot access the same command object, however multiple commands can be executing
-/// concurrently against a single connection.
-/// </param>
-/// <param name="FdoThreadCapability_MultiThreaded">
-/// The feature provider is fully multi-threaded. Concurrent thread access is safe
-/// for all objects.
-/// </param>
enum FdoThreadCapability
{
/// The feature provider is not thread safe.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionException.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionException.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionException.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,8 +31,8 @@
/// specific.
class FdoConnectionException : public FdoException
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoConnectionException.
///
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionState.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionState.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionState.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,22 +23,9 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoConnectionState enumeration indicates the current state of the connection
-/// <param name="FdoConnectionState_Busy">
-/// The connection is busy executing one or more commands. Executing another
-/// command while the connection is busy will result in an exception.
-/// </param>
-/// <param name="FdoConnectionState_Closed">
-/// The connection is closed.
-/// </param>
-/// <param name="FdoConnectionState_Open">
-/// The connection is open.
-/// </param>
-/// <param name="FdoConnectionState_Pending">
-/// The connection is pending. this is used to indicate that the application has
-/// issued an Open request, but the open is not completed because the application needs to include additional connection property values.
-/// </param>
enum FdoConnectionState
{
/// The connection is busy executing one or more commands. Executing another
@@ -51,7 +38,9 @@
/// The connection is open.
FdoConnectionState_Open,
- /// The connection is open.
+ /// The connection is pending. this is used to indicate that the application has
+ /// issued an Open request, but the open is not completed because the application
+ /// needs to include additional connection property values.
FdoConnectionState_Pending
};
#endif
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/ProviderDatastoreType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/ProviderDatastoreType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Connections/ProviderDatastoreType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -22,21 +22,10 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoProviderDatastoreType enumeration lists all of the concrete provider
/// types supported by FDO.
-/// <param name="FdoProviderDatastoreType_DatabaseServer">
-/// Indicates that the provider is a database-based provider.
-/// </param>
-/// <param name="FdoProviderDatastoreType_File">
-/// Indicates that the provider is a file-based provider.
-/// </param>
-/// <param name="FdoProviderDatastoreType_WebServer">
-/// Indicates that the provider is a web-based provider.
-/// </param>
-/// <param name="FdoProviderDatastoreType_Unknown">
-/// Indicates that the provider is of an unknown provider type.
-/// </param>
enum FdoProviderDatastoreType
{
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BLOBValue.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BLOBValue.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BLOBValue.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -61,8 +61,8 @@
FDO_API FdoString* ToString();
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoBLOBValue with a value of null.
/// \return
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BinaryExpression.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BinaryExpression.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BinaryExpression.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -33,8 +33,8 @@
/// and divide.
class FdoBinaryExpression : public FdoExpression
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoBinaryExpression.
FdoBinaryExpression();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BinaryOperations.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BinaryOperations.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BinaryOperations.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,29 +23,22 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoBinaryOperations enumeration lists the binary expression operations
/// available.
-/// <param name="FdoBinaryOperations_Add">
-/// Add the two expressions or concatenate two string expressions
-/// </param>
-/// <param name="FdoBinaryOperations_Subtract">
-/// Subtract the two expressions
-/// </param>
-/// <param name="FdoBinaryOperations_Multiply">
-/// Multiply the two expressions
-/// </param>
-/// <param name="FdoBinaryOperations_Divide">
-/// Divide the two expressions
-/// </param>
enum FdoBinaryOperations
{
+ /// Add the two expressions or concatenate two string expressions
FdoBinaryOperations_Add,
+ /// Subtract the two expressions
FdoBinaryOperations_Subtract,
+ /// Multiply the two expressions
FdoBinaryOperations_Multiply,
+ /// Divide the two expressions
FdoBinaryOperations_Divide
};
#endif
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BooleanValue.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BooleanValue.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/BooleanValue.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,8 +31,8 @@
/// value.
class FdoBooleanValue : public FdoDataValue
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoBooleanValue with a
/// value of null.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ByteValue.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ByteValue.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ByteValue.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -32,8 +32,8 @@
/// byte value.
class FdoByteValue : public FdoDataValue
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoByteValue with a value of null.
/// \return
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/CLOBValue.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/CLOBValue.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/CLOBValue.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -32,8 +32,8 @@
/// CLOB value.
class FdoCLOBValue : public FdoLOBValue
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoCLOBValue with a value of null.
///
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ComputedIdentifier.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ComputedIdentifier.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ComputedIdentifier.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -45,8 +45,8 @@
///
class FdoComputedIdentifier : public FdoIdentifier
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an identifier.
FdoComputedIdentifier();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DataValue.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DataValue.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DataValue.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -32,8 +32,8 @@
/// value such as a string or a number.
class FdoDataValue : public FdoLiteralValue
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoDataValue with data type string and a
/// value of null.
@@ -215,13 +215,15 @@
// Get the value as an XML format string.
FdoString* GetXmlValue();
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
bool m_isNull;
FdoStringP m_XmlValue; // Manages GetXmlValue return string when datatype is datetime.
+/// \endcond
+
};
-/// \endcond
+/// \ingroup (typedefs)
/// \brief
/// FdoDataValueP is a FdoPtr on FdoDataValue, provided for convenience.
typedef FdoPtr<FdoDataValue> FdoDataValueP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DataValueCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DataValueCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DataValueCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -55,6 +55,7 @@
FDO_API static FdoDataValueCollection* Create();
};
+/// \ingroup (typedefs)
/// \brief
/// FdoDataValueCollectionP is a FdoPtr on FdoDataValueCollection, provided for convenience.
typedef FdoPtr<FdoDataValueCollection> FdoDataValueCollectionP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DateTimeValue.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DateTimeValue.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DateTimeValue.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,8 +31,8 @@
/// The FdoDateTimeValue class derives from FdoDataValue and represents a date or time.
class FdoDateTimeValue : public FdoDataValue
{
+/// \cond DOXYGEN-IGNORE
protected:
-// // \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoDateTimeValue with a
/// value of null.
@@ -63,7 +63,7 @@
virtual ~FdoDateTimeValue();
virtual void Dispose();
-// // \endcond
+ /// \endcond
public:
/// \brief
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DecimalValue.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DecimalValue.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DecimalValue.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,8 +31,8 @@
/// The FdoDecimalValue class derives from FdoDataValue and represents a decimal value.
class FdoDecimalValue : public FdoDataValue
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoDecimalValue with a
/// value of null.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DoubleValue.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DoubleValue.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/DoubleValue.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,8 +31,8 @@
/// The FdoDoubleValue class derives from FdoDataValue and represents a double-precision floating point number.
class FdoDoubleValue : public FdoDataValue
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoDoubleValue with a
/// value of null.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ExpressionException.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ExpressionException.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ExpressionException.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,8 +31,8 @@
/// environment specific.
class FdoExpressionException : public FdoException
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoExpressionException.
FdoExpressionException();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ExpressionType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ExpressionType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/ExpressionType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,24 +23,19 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoExpressionType enumeration defines the expression types available. This
/// enumeration is used in the capabilities metadata.
-/// <param name="FdoExpressionType_Basic">
-/// Basic arithmetic expressions e.g.: +, -, *, /, negate, and string concatenation.
-/// </param>
-/// <param name="FdoExpressionType_Function">
-/// Function evaluations
-/// </param>
-/// <param name="FdoExpressionType_Parameter">
-/// Parameter substitutions
-/// </param>
enum FdoExpressionType
{
+ /// Basic arithmetic expressions e.g.: +, -, *, /, negate, and string concatenation.
FdoExpressionType_Basic,
+ /// Function evaluations
FdoExpressionType_Function,
+ /// Parameter substitutions
FdoExpressionType_Parameter
};
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Function.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Function.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Function.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -33,8 +33,8 @@
/// be passed to it.
class FdoFunction : public FdoExpression
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoFunction.
FdoFunction();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/GeometryValue.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/GeometryValue.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/GeometryValue.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -30,8 +30,8 @@
/// The FdoGeometryValue class derives from FdoLiteralValue and represents a geometric value.
class FdoGeometryValue : public FdoLiteralValue
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoGeometryValue with a value of null.
FdoGeometryValue();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Identifier.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Identifier.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Identifier.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -37,8 +37,8 @@
/// property name "Address.City".
class FdoIdentifier : public FdoExpression
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an identifier.
FdoIdentifier();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Int16Value.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Int16Value.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Int16Value.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,8 +31,8 @@
/// The FdoInt16Value class derives from FdoDataValue and represents a 16-bit signed integer value.
class FdoInt16Value : public FdoDataValue
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoInt16Value with a
/// value of null.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Int32Value.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Int32Value.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Int32Value.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,8 +31,8 @@
/// The FdoInt32Value class derives from FdoDataValue and represents a 32-bit signed integer value.
class FdoInt32Value : public FdoDataValue
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoInt32Value with a
/// value of null.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Int64Value.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Int64Value.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Int64Value.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,8 +31,8 @@
/// The FdoInt64Value class derives from FdoDataValue and represents a 64-bit signed integer value.
class FdoInt64Value : public FdoDataValue
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoInt64Value with a
/// value of null.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Parameter.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Parameter.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/Parameter.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -36,8 +36,8 @@
/// FdoICommand interface and FdoParameterValue.
class FdoParameter : public FdoValueExpression
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of a parameter.
FdoParameter();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/SingleValue.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/SingleValue.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/SingleValue.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,8 +31,8 @@
/// The FdoSingleValue class derives from FdoDataValue and represents a single precision floating point number.
class FdoSingleValue : public FdoDataValue
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoSingleValue with a
/// value of null.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/StringValue.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/StringValue.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/StringValue.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,8 +31,8 @@
/// The FdoStringValue class derives from FdoDataValue and represents a literal string.
class FdoStringValue : public FdoDataValue
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of an FdoStringValue with a
/// value of null.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/UnaryExpression.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/UnaryExpression.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/UnaryExpression.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -32,8 +32,8 @@
/// arithmetic expressions.
class FdoUnaryExpression : public FdoExpression
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoUnaryExpression.
FdoUnaryExpression();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/UnaryOperations.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/UnaryOperations.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Expression/UnaryOperations.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,13 +23,13 @@
#pragma once
#endif
+
+/// \ingroup (enums)
/// \brief
/// The FdoUnaryOperations enumeration lists the unary expression operations available.
-/// <param name="FdoUnaryOperations_Negate">
-/// Negate the expression
-/// </param>
enum FdoUnaryOperations
{
+ /// Negate the expression
FdoUnaryOperations_Negate
};
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperations.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperations.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperations.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperator.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperator.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/BinaryLogicalOperator.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonCondition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonCondition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonCondition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonOperations.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonOperations.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ComparisonOperations.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ConditionType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ConditionType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ConditionType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceCondition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceCondition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceCondition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceOperations.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceOperations.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/DistanceOperations.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/Filter.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/Filter.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/Filter.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/FilterException.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/FilterException.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/FilterException.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/GeometricCondition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/GeometricCondition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/GeometricCondition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/InCondition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/InCondition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/InCondition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/NullCondition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/NullCondition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/NullCondition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialCondition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialCondition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialCondition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialOperations.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialOperations.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/SpatialOperations.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperations.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperations.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperations.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperator.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperator.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/UnaryLogicalOperator.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ValueExpressionCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ValueExpressionCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Filter/ValueExpressionCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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>()
{
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModel.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModel.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModel.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -155,7 +155,7 @@
/// \brief
/// Sets the data type.
///
- /// \param value
+ /// \param dataType
/// Specifies the data type the raster data is to be returned in.
///
FDO_API virtual void SetDataType (FdoRasterDataType dataType);
@@ -163,7 +163,7 @@
/// \brief
/// Compares this raster data model with another one.
///
- /// \param value
+ /// \param pModel
/// The Raster Data Model to compare with
///
/// \return
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModelType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModelType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataModelType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,6 +23,7 @@
#include <FdoStd.h>
+/// \ingroup (enums)
/// \brief
/// The FdoRasterDataModelType enumeration specifies the type of
/// data within each pixel. In all cases the data is 'packed', that is,
@@ -38,28 +39,6 @@
/// allocated to each band, so for example RGBT data with eight bits for red,
/// would also have eight bits for each of the three other bands totaling
/// thirty-two bits (BitsPerPixel=32).
-/// <param name="FdoRasterDataModelType_Unknown">
-/// Data is organized in an unknown or provider specific manner.
-/// </param>
-/// <param name="FdoRasterDataModelType_Bitonal">
-/// Data is organized as one bit (black/white - bitonal) data.
-/// </param>
-/// <param name="FdoRasterDataModelType_Gray">
-/// Data is monochrome (black->gray->white) pixels.
-/// It is necessary to know the BitsPerPixel value to interpret the data.
-/// </param>
-/// <param name="FdoRasterDataModelType_RGB">
-/// Data is red/green/blue (in that order) pixels.
-/// It is necessary to know the BitsPerPixel value to interpret the data.
-/// </param>
-/// <param name="FdoRasterDataModelType_RGBA">
-/// Data is red/green/blue/alpha (in that order) pixels; RGB with transparency.
-/// It is necessary to know the BitsPerPixel value to interpret the data.
-/// </param>
-/// <param name="FdoRasterDataModelType_Palette">
-/// Data is monochrome but backed by a pallette (value->pallette->colour) pixels.
-/// It is necessary to know the BitsPerPixel value to interpret the data.
-/// </param>
enum FdoRasterDataModelType
{
/// Data is organized in an unknown or provider specific manner.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataOrganization.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataOrganization.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataOrganization.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,6 +23,7 @@
#include <FdoStd.h>
+/// \ingroup (enums)
/// \brief
/// The FdoRasterDataOrganization enumeration specifies the way
/// pixel data is interleaved. Data is stored/retrieved in left to right,
@@ -35,15 +36,7 @@
/// followed by the same number of green bytes, followed by the same
/// number of blue bytes. This organization dependant storage should be
/// considered when 'skipping' to the middle of an image.
-/// <param name="FdoRasterDataOrganization_Pixel">
-/// Data is interleaved by pixel, with all data for a pixel contiguous in memory.
/// </param>
-/// <param name="FdoRasterDataOrganization_Row">
-/// Data is interleaved by row, with all data of a channel for one row contiguous in memory, followed by a rows worth of the next channel, etc.
-/// </param>
-/// <param name="FdoRasterDataOrganization_Image">
-/// Data is interleaved by image, with all data of a channel for a complete image contiguous in memory, followed by a complete image of the next channel, etc.
-/// </param>
enum FdoRasterDataOrganization
{
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Raster/RasterDataType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,33 +23,24 @@
#include <FdoStd.h>
+/// \ingroup (enums)
/// \brief
/// The FdoRasterDataType enumeration specifies the type of data stored in the Raster Image.
-/// <param name="FdoRasterDataType_Unknown">
-/// Data is organized in an unknown or provider specific manner.
-/// </param>
-/// <param name="FdoRasterDataType_UnsignedInteger">
-/// Data is organized as Unsigned Integers.
-/// </param>
-/// <param name="FdoRasterDataType_Integer">
-/// Data is organized as Signed Integers.
-/// </param>
-/// <param name="FdoRasterDataType_Float">
-/// Data is organized as Floats.
-/// </param>
-/// <param name="FdoRasterDataType_Double">
-/// Data is organized as Doubles.
-/// </param>
enum FdoRasterDataType
{
+ /// Data is organized in an unknown or provider specific manner.
FdoRasterDataType_Unknown,
+ /// Data is organized as Unsigned Integers.
FdoRasterDataType_UnsignedInteger,
+ /// Data is organized as Signed Integers.
FdoRasterDataType_Integer,
+ /// Data is organized as Floats.
FdoRasterDataType_Float,
+ /// Data is organized as Doubles.
FdoRasterDataType_Double
};
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/AssociationPropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/AssociationPropertyDefinition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/AssociationPropertyDefinition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -345,6 +345,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoAssociationPropertyP is a FdoPtr on FdoAssociationPropertyDefinition, provided for convenience.
typedef FdoPtr<FdoAssociationPropertyDefinition> FdoAssociationPropertyP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/AutogenerationException.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/AutogenerationException.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/AutogenerationException.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -33,8 +33,8 @@
/// or possibly because of provider-specific errors.
class FdoAutogenerationException : public FdoSchemaException
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoAutogenerationException.
FdoAutogenerationException();
@@ -85,6 +85,7 @@
FDO_API static FdoAutogenerationException* Create(FdoString* name, FdoException* cause);
};
+/// \ingroup (typedefs)
/// \brief
/// FdoSchemaExceptionP is a FdoPtr on FdoAutogenerationException, provided for convenience.
typedef FdoPtr<FdoAutogenerationException> FdoAutogenerationExceptionP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/Class.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/Class.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/Class.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -35,8 +35,8 @@
/// commands. The Class type does not pre-define any base properties.
class FdoClass : public FdoClassDefinition
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoClass.
FdoClass();
@@ -79,6 +79,7 @@
FDO_API virtual FdoClassType GetClassType();
/// \cond DOXYGEN-IGNORE
+
/// Public non-API functions for XML support
/// Initialize this class from its XML attributes
@@ -89,6 +90,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoClassP is a FdoPtr on FdoClass, provided for convenience.
typedef FdoPtr<FdoClass> FdoClassP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassCapabilities.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassCapabilities.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassCapabilities.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -146,6 +146,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoClassCapabilitiesP is a FdoPtr on FdoClassCapabilities, provided for convenience.
typedef FdoPtr<FdoClassCapabilities> FdoClassCapabilitiesP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -66,6 +66,7 @@
FDO_API static FdoClassCollection* Create(FdoSchemaElement* parent);
};
+/// \ingroup (typedefs)
/// \brief
/// FdoClassesP is a FdoPtr on FdoClassCollection, provided for convenience.
typedef FdoPtr<FdoClassCollection> FdoClassesP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassDefinition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassDefinition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -47,8 +47,8 @@
friend class FdoRelation;
friend class FdoObjectPropertyDefinition;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of a ClassDefinition.
FdoClassDefinition();
@@ -227,6 +227,7 @@
FDO_API FdoUniqueConstraintCollection* GetUniqueConstraints();
/// \cond DOXYGEN-IGNORE
+
// Public non-API functions for XML and Schema Merge support
// Update a class definition from the given definition.
@@ -318,6 +319,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoClassDefinitionP is a FdoPtr on FdoClassDefinition, provided for convenience.
typedef FdoPtr<FdoClassDefinition> FdoClassDefinitionP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ClassType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -22,27 +22,10 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoClassType enumeration lists all of the concrete class types defined in
/// the Schema package.
-/// <param name="FdoClassType_Class">
-/// Represents the concrete class type Class
-/// </param>
-/// <param name="FdoClassType_FeatureClass">
-/// Represents the concrete class type FeatureClass
-/// </param>
-/// <param name="FdoClassType_NetworkClass">
-/// Represents the concrete class type NetworkClass
-/// </param>
-/// <param name="FdoClassType_NetworkLayerClass">
-/// Represents the concrete class type NetworkLayerClass
-/// </param>
-/// <param name="FdoClassType_NetworkNodeClass">
-/// Represents the concrete class type NetworkNodeClass
-/// </param>
-/// <param name="FdoClassType_NetworkLinkClass">
-/// Represents the concrete class type NetworkLinkClass
-/// </param>
enum FdoClassType
{
/// Represents the concrete class type Class.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DataPropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DataPropertyDefinition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DataPropertyDefinition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -38,8 +38,8 @@
template <class OBJ> friend class FdoSchemaCollection;
friend class FdoObjectPropertyDefinition;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoDataPropertyDefinition.
FdoDataPropertyDefinition();
@@ -333,6 +333,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoDataPropertyP is a FdoPtr on FdoDataPropertyDefinition, provided for convenience.
typedef FdoPtr<FdoDataPropertyDefinition> FdoDataPropertyP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DataPropertyDefinitionCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DataPropertyDefinitionCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DataPropertyDefinitionCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -116,6 +116,7 @@
FDO_API virtual void Insert(FdoInt32 index, FdoDataPropertyDefinition* value);
};
+/// \ingroup (typedefs)
/// \brief
/// FdoDataPropertiesP is a FdoPtr on FdoDataPropertyDefinitionCollection, provided for convenience.
typedef FdoPtr<FdoDataPropertyDefinitionCollection> FdoDataPropertiesP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DataType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DataType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DataType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -22,48 +22,9 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoDataType enumeration lists all of the base data types supported by FDO.
-/// <param name="FdoDataType_Boolean">
-/// Represents a Boolean value of true or false
-/// </param>
-/// <param name="FdoDataType_Byte">
-/// Represents unsigned 8-bit integers with values between 0 and 255
-/// </param>
-/// <param name="FdoDataType_DateTime">
-/// Represents a date and time value
-/// </param>
-/// <param name="FdoDataType_Decimal">
-/// Represents values ranging from 1.0 x 10^-28 to approximately 7.9 x 10^28,
-/// with 28-29 significant digits
-/// </param>
-/// <param name="FdoDataType_Double">
-/// Represents a floating point value ranging from approximately 5.0
-/// x 10^-324 to 1.7 x 10^308 with a precision of 15-16 digits
-/// </param>
-/// <param name="FdoDataType_Int16">
-/// Represents signed 16-bit integers with values between -32768 and 32767
-/// </param>
-/// <param name="FdoDataType_Int32">
-/// Represents signed 32-bit integers with values between -2147483648 and 2147483647
-/// </param>
-/// <param name="FdoDataType_Int64">
-/// Represents signed 64-bit integers with values between -9223372036854775808 and 9223372036854775807
-/// </param>
-/// <param name="FdoDataType_Single">
-/// Represents floating point values ranging from approximately 1.5 x 10^-45
-/// to 3.4 x 10^38, with a precision of 7 digits
-/// </param>
-/// <param name="FdoDataType_String">
-/// Represents a Unicode character string
-/// </param>
-/// <param name="FdoDataType_BLOB">
-/// Represents a binary large object stored as a collection of bytes
-/// </param>
-/// <param name="FdoDataType_CLOB">
-/// Represents a character large object stored as a collection of
-/// characters
-/// </param>
enum FdoDataType
{
/// Represents a Boolean value of true or false.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DeleteRule.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DeleteRule.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/DeleteRule.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -22,19 +22,11 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoDeleteRule enumeration specifies the action to take when a delete
/// operation is executed on the class instance at the other end of the
/// relation.
-/// <param name="FdoDeleteRule_Cascade">
-/// Cascade the delete operation to class instances at this end of the relation
-/// </param>
-/// <param name="FdoDeleteRule_Prevent">
-/// Prevent the delete operation if there are class instances at this end of the relation
-/// </param>
-/// <param name="FdoDeleteRule_Break">
-/// Break the relationship by setting the identifying properties at this end to null values
-/// </param>
enum FdoDeleteRule
{
/// Cascade the delete operation to class instances at this end of the relation.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureClass.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureClass.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureClass.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -38,8 +38,8 @@
{
template <class OBJ> friend class FdoSchemaCollection;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoFeatureClass.
FdoFeatureClass();
@@ -136,6 +136,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoFeatureClassP is a FdoPtr on FdoFeatureClass, provided for convenience.
typedef FdoPtr<FdoFeatureClass> FdoFeatureClassP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureClassCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureClassCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureClassCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -29,8 +29,8 @@
/// The FdoFeatureClassCollection class represents a collection of FdoFeatureClasse objects.
class FdoFeatureClassCollection: public FdoSchemaCollection<FdoFeatureClass>
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs an instance of a FeatureClassCollection using the specified argument.
FdoFeatureClassCollection(FdoSchemaElement* parent) : FdoSchemaCollection<FdoFeatureClass>(parent)
{
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureSchema.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureSchema.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureSchema.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -45,8 +45,8 @@
public FdoSchemaElement,
public FdoXmlSerializable
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default empty instance of an FdoFeatureSchema.
FdoFeatureSchema();
@@ -135,6 +135,7 @@
FDO_API virtual FdoXmlReader* GetFromInternalStylesheet();
/// \cond DOXYGEN-IGNORE
+
/// Public non-API functions for XML serialization and Schema Merge
/// Merge the given schema into this schema. An additive merge
@@ -169,6 +170,7 @@
FdoClassCollection* m_classes;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoFeatureSchemaP is a FdoPtr on FdoFeatureSchema, provided for convenience.
typedef FdoPtr<FdoFeatureSchema> FdoFeatureSchemaP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureSchemaCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureSchemaCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/FeatureSchemaCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -38,8 +38,8 @@
public FdoXmlDeserializable,
public FdoXmlSerializable
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoFeatureSchemaCollection()
{
}
@@ -119,7 +119,8 @@
///
FDO_API FdoPhysicalSchemaMappingCollection* GetXmlSchemaMappings();
- /// \cond DOXYGEN-IGNORE
+/// \cond DOXYGEN-IGNORE
+
/// FdoXmlDeserializable override for getting the SAX Context for reading
/// Feature Schemas. Not exposed via the FDO API.
virtual FdoXmlSaxContext* GetSaxContext();
@@ -145,6 +146,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoFeatureSchemasP is a FdoPtr on FdoFeatureSchemaCollection, provided for convenience.
typedef FdoPtr<FdoFeatureSchemaCollection> FdoFeatureSchemasP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/GeometricPropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/GeometricPropertyDefinition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/GeometricPropertyDefinition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -47,8 +47,8 @@
{
friend class FdoFeatureClass;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoGeometricPropertyDefinition.
FdoGeometricPropertyDefinition();
@@ -325,6 +325,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoGeometricPropertyP is a FdoPtr on FdoGeometricPropertyDefinition, provided for convenience.
typedef FdoPtr<FdoGeometricPropertyDefinition> FdoGeometricPropertyP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/GeometricType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/GeometricType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/GeometricType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -22,21 +22,11 @@
#pragma once
#endif
+
+/// \ingroup (enums)
/// \brief
/// The FdoGeometricType enumeration categorizes all of the geometry types
/// supported by FDO based on their geometric dimensionality.
-/// <param name="FdoGeometricType_Point">
-/// Represents 0-dimensional geometric primitives, such as Points
-/// </param>
-/// <param name="FdoGeometricType_Curve">
-/// Represents 1 dimensional geometric primitives, such as Curves and Lines
-/// </param>
-/// <param name="FdoGeometricType_Surface">
-/// Represents 2 dimensional geometric primitives, such as Polygons
-/// </param>
-/// <param name="FdoGeometricType_Solid">
-/// Represents 3 dimensional geometric primitives, such as Cubes
-/// </param>
enum FdoGeometricType
{
/// Represents 0-dimensional geometric primitives, such as Points.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/MergeContext.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/MergeContext.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/MergeContext.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,6 +31,7 @@
#include <Fdo/Xml/Flags.h>
/// \cond DOXYGEN-IGNORE
+
/// \brief
/// FdoSchemaMergeContext provides support for updating a set of feature schemas
/// base on a second set of schemas. It's main purpose is to support the reading
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkClass.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkClass.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkClass.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -42,8 +42,8 @@
class FdoNetworkClass : public FdoClassDefinition
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoNetworkClass.
FdoNetworkClass();
@@ -106,6 +106,7 @@
FDO_API void SetLayerClass(FdoNetworkLayerClass* value);
/// \cond DOXYGEN-IGNORE
+
/// Public non-API functions for XML and Schema Merge support
/// Update this property from the given property.
@@ -135,6 +136,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoNetworkClassP is a FdoPtr on FdoNetworkClass, provided for convenience.
typedef FdoPtr<FdoNetworkClass> FdoNetworkClassP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkFeatureClass.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkFeatureClass.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkFeatureClass.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -37,8 +37,8 @@
class FdoNetworkFeatureClass : public FdoFeatureClass
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoNetworkFeatureClass.
/// To make a class of this type, you need to either create a FdoNetworkNodeFeatureClass
/// or FdoNetworkLinkFeatureClass.
@@ -192,6 +192,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoNetworkFeatureClassP is a FdoPtr on FdoNetworkFeatureClass, provided for convenience.
typedef FdoPtr<FdoNetworkFeatureClass> FdoNetworkFeatureClassP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkLayerClass.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkLayerClass.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkLayerClass.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -36,8 +36,8 @@
class FdoNetworkLayerClass : public FdoClassDefinition
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoNetworkLayerClass.
FdoNetworkLayerClass();
@@ -80,6 +80,7 @@
FDO_API virtual FdoClassType GetClassType();
/// \cond DOXYGEN-IGNORE
+
/// Public non-API functions for XML and Schema Merge support
/// Update this property from the given property.
@@ -101,6 +102,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoNetworkLayerClassP is a FdoPtr on FdoNetworkLayerClass, provided for convenience.
typedef FdoPtr<FdoNetworkLayerClass> FdoNetworkLayerClassP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkLinkFeatureClass.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkLinkFeatureClass.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkLinkFeatureClass.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -37,8 +37,8 @@
class FdoNetworkLinkFeatureClass : public FdoNetworkFeatureClass
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoNetworkLinkFeatureClass.
FdoNetworkLinkFeatureClass();
@@ -174,6 +174,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoNetworkLinkFeatureClassP is a FdoPtr on FdoNetworkLinkFeatureClass, provided for convenience.
typedef FdoPtr<FdoNetworkLinkFeatureClass> FdoNetworkLinkFeatureClassP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkNodeFeatureClass.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkNodeFeatureClass.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/NetworkNodeFeatureClass.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -36,8 +36,8 @@
class FdoNetworkNodeFeatureClass : public FdoNetworkFeatureClass
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoNetworkNodeFeatureClass.
FdoNetworkNodeFeatureClass();
@@ -150,6 +150,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoNetworkNodeFeatureClassP is a FdoPtr on FdoNetworkNodeFeatureClass, provided for convenience.
typedef FdoPtr<FdoNetworkNodeFeatureClass> FdoNetworkNodeFeatureClassP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ObjectPropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ObjectPropertyDefinition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ObjectPropertyDefinition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -215,6 +215,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoObjectPropertyP is a FdoPtr on FdoObjectPropertyDefinition, provided for convenience.
typedef FdoPtr<FdoObjectPropertyDefinition> FdoObjectPropertyP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ObjectType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ObjectType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/ObjectType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -22,18 +22,10 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoObjectType enumeration defines whether an object property is a single
/// value, a collection, or an ordered collection.
-/// <param name="FdoObjectType_Value">
-/// Represents a simple value property
-/// </param>
-/// <param name="FdoObjectType_Collection">
-/// Represents a property that is a collection of values
-/// </param>
-/// <param name="FdoObjectType_OrderedCollection">
-/// Represents a property that is an ordered collection of values
-/// </param>
enum FdoObjectType
{
/// Represents a simple value property.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/OrderType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/OrderType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/OrderType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -22,15 +22,10 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoOrderType enumeration list contains two values to indicate if the
/// object collection is to be ordered in ascending or descending fashion.
-/// <param name="FdoOrderType_Ascending">
-/// Specifies the collection is to be ordered from the smallest value to the largest value
-/// </param>
-/// <param name="FdoOrderType_Descending">
-/// Specifies the collection is to be ordered from the largest value to the smallest value
-/// </param>
enum FdoOrderType
{
/// Specifies the collection is to be ordered from the smallest value to the largest value.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyDefinition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyDefinition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -32,8 +32,8 @@
/// FdoGeometricPropertyDefinition, and FdoObjectPropertyDefinition.
class FdoPropertyDefinition : public FdoSchemaElement
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of a PropertyDefinition.
FdoPropertyDefinition();
@@ -81,6 +81,7 @@
FDO_API virtual void SetIsSystem( bool value );
/// \cond DOXYGEN-IGNORE
+
/// Public non-API functions for XML and Schema Merge support
/// Update this property from the given property.
@@ -98,6 +99,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoPropertyP is a FdoPtr on FdoPropertyDefinition, provided for convenience.
typedef FdoPtr<FdoPropertyDefinition> FdoPropertyP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyDefinitionCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyDefinitionCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyDefinitionCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -88,6 +88,7 @@
FDO_API virtual void RemoveAt(FdoInt32 index);
};
+/// \ingroup (typedefs)
/// \brief
/// FdoPropertiesP is a FdoPtr on FdoPropertyDefinitionCollection, provided for convenience.
typedef FdoPtr<FdoPropertyDefinitionCollection> FdoPropertiesP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -22,23 +22,9 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoPropertyType enumeration lists the possible types that a Property can be.
-/// <param name="FdoPropertyType_DataProperty">
-/// Represents a Data Property type
-/// </param>
-/// <param name="FdoPropertyType_ObjectProperty">
-/// Represents an Object Property type
-/// </param>
-/// <param name="FdoPropertyType_GeometricProperty">
-/// Represents a Geometric Property type
-/// </param>
-/// <param name="FdoPropertyType_AssociationProperty">
-/// Represents an Association Property type
-/// </param>
-/// <param name="FdoPropertyType_RasterProperty">
-/// Represents a Raster (image) Property type
-/// </param>
enum FdoPropertyType
{
/// Represents a Data Property type.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyValueConstraintType.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyValueConstraintType.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/PropertyValueConstraintType.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -22,21 +22,18 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoPropertyValueConstraintType enumeration categorizes the
/// supported constraint.
-/// <param name="FdoPropertyValueConstraintType_Range">
-/// This constraint specifies minimum and / or maximum allowed values for a particular property. It can be used for all data property types except for Boolean, BLOB, or CLOB
-/// </param>
-/// <param name="FdoPropertyValueConstraintType_List">
-/// This constraint specifies a list of allowed values for a particular property. It can be used for all data property types except for Boolean, BLOB, or CLOB
-/// </param>
enum FdoPropertyValueConstraintType
{
- /// Represents a range constaint.
+ /// Specifies minimum and / or maximum allowed values for a particular property.
+ /// It can be used for all data property types except for Boolean, BLOB, or CLOB.
FdoPropertyValueConstraintType_Range = 0x01,
- /// Represents a list constraint.
+ /// Specifies a list of allowed values for a particular property.
+ /// It can be used for all data property types except for Boolean, BLOB, or CLOB.
FdoPropertyValueConstraintType_List = 0x02
};
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/RasterPropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/RasterPropertyDefinition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/RasterPropertyDefinition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -39,8 +39,8 @@
friend class FdoFeatureClass;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoRasterPropertyDefinition.
FdoRasterPropertyDefinition ();
@@ -214,7 +214,7 @@
/// \brief
/// Sets a Spatial Context association for this raster property.
///
- /// \param value
+ /// \param spatialContextName
/// Input the Spatial Context name to be set.
/// Defaults to the active Spatial Context.
///
@@ -233,6 +233,7 @@
/// \cond DOXYGEN-IGNORE
+
/// Public non-API functions for XML and Schema Merge support
/// Update this property from the given property.
@@ -280,6 +281,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoRasterPropertyP is a FdoPtr on FdoRasterPropertyDefinition, provided for convenience.
typedef FdoPtr<FdoRasterPropertyDefinition> FdoRasterPropertyP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaAttributeDictionary.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaAttributeDictionary.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaAttributeDictionary.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -38,8 +38,8 @@
{
friend class FdoSchemaElement;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoSchemaAttributeDictionary()
{
}
@@ -141,6 +141,7 @@
FDO_API void Clear();
/// \cond DOXYGEN-IGNORE
+
/// Public non-API functions for XML support
/// Handle the start of a dictionary element
@@ -195,6 +196,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoSADP is a FdoPtr on FdoSchemaAttributeDictionary, provided for convenience.
typedef FdoPtr<FdoSchemaAttributeDictionary> FdoSADP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -35,8 +35,8 @@
template <class OBJ> class FdoSchemaCollection : public FdoNamedCollection<OBJ, FdoSchemaException>
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoSchemaCollection()
{
}
@@ -356,8 +356,8 @@
FdoNamedCollection<OBJ, FdoSchemaException>::RemoveAt(index);
}
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// States stored in the m_changeInfoState bitfield flag
static const unsigned int CHANGEINFO_PRESENT = 0x00000001;
static const unsigned int CHANGEINFO_PROCESSING = 0x00000002;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaElement.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaElement.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaElement.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -50,8 +50,8 @@
friend class FdoNetworkFeatureClass;
friend class FdoNetworkLinkFeatureClass;
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoSchemaElement.
FdoSchemaElement();
@@ -268,7 +268,7 @@
/// \endcond
};
-
+/// \ingroup (typedefs)
/// \brief
/// FdoSchemaElementP is a FdoPtr on FdoSchemaElement, provided for convenience.
typedef FdoPtr<FdoSchemaElement> FdoSchemaElementP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaElementState.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaElementState.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaElementState.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -23,23 +23,9 @@
#pragma once
#endif
+/// \ingroup (enums)
/// \brief
/// The FdoSchemaElementState enumeration defines the current state of the schema element
-/// <param name="FdoSchemaElementState_Added">
-/// Indicates the schema element has been added
-/// </param>
-/// <param name="FdoSchemaElementState_Deleted">
-/// Indicates the schema element is marked for deletion
-/// </param>
-/// <param name="FdoSchemaElementState_Detached">
-/// Indicates the schema element is not associated with an FdoFeatureSchema
-/// </param>
-/// <param name="FdoSchemaElementState_Modified">
-/// Indicates the schema element has been modified in some way
-/// </param>
-/// <param name="FdoSchemaElementState_Unchanged">
-/// Indicates the schema element has not been changed
-/// </param>
enum FdoSchemaElementState
{
/// Indicates the schema element has been added.
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaException.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaException.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/SchemaException.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -30,8 +30,8 @@
/// environment-specific.
class FdoSchemaException : public FdoException
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructs a default instance of an FdoSchemaException.
FdoSchemaException();
@@ -82,6 +82,7 @@
FDO_API static FdoSchemaException* Create(FdoString* name, FdoException* cause);
};
+/// \ingroup (typedefs)
/// \brief
/// FdoSchemaExceptionP is a FdoPtr on FdoSchemaException, provided for convenience.
typedef FdoPtr<FdoSchemaException> FdoSchemaExceptionP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/TopoFeaturePropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/TopoFeaturePropertyDefinition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/TopoFeaturePropertyDefinition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -60,6 +60,7 @@
);
/// \cond DOXYGEN-IGNORE
+
/// Public non-API functions for XML support
/// Initialize the class from its XML attributes
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/TopoGeometryPropertyDefinition.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/TopoGeometryPropertyDefinition.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/TopoGeometryPropertyDefinition.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -76,6 +76,7 @@
);
/// \cond DOXYGEN-IGNORE
+
/// Public non-API functions for XML support
/// Initialize the class from its XML attributes
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/Topology.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/Topology.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/Topology.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -117,7 +117,8 @@
///
virtual void Dispose ();
- /// \cond DOXYGEN-IGNORE
+/// \cond DOXYGEN-IGNORE
+
/// Hide default constructor to ensure that it cannot be used.
FdoTopology() {};
virtual ~FdoTopology();
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/UniqueConstraint.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/UniqueConstraint.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/UniqueConstraint.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -68,6 +68,7 @@
FdoDataPropertyDefinitionCollection* m_properties;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoUniqueConstraintP is a FdoPtr on FdoUniqueConstraint, provided for convenience.
typedef FdoPtr<FdoUniqueConstraint> FdoUniqueConstraintP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/UniqueConstraintCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/UniqueConstraintCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Schema/UniqueConstraintCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -55,6 +55,9 @@
FDO_API static FdoUniqueConstraintCollection* Create();
};
+/// \ingroup (typedefs)
+/// \brief
+/// FdoUniqueConstraintCollectionP is a FdoPtr on FdoUniqueConstraintCollection, provided for convenience.
typedef FdoPtr<FdoUniqueConstraintCollection> FdoUniqueConstraintCollectionP;
#endif
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ClassMapping.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ClassMapping.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ClassMapping.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -45,6 +45,8 @@
/// set when the type represents geometries and indicates what kind of geometries the type
/// represents. wkBaseName must be L"" or one of the constants defined in
/// commonGml212Gml212.h.
+ /// \param wkSchemaName
+ /// Well-known schema name.
///
/// \return
/// Returns FdoXmlClassMapping
@@ -90,6 +92,7 @@
FDO_API FdoXmlElementMappingCollection* GetElementMappings();
/// \cond DOXYGEN-IGNORE
+
/// \brief
/// Writes this XML Class Mapping to XML. Called when
/// the element is serialized to XML.
@@ -108,8 +111,8 @@
);
/// \endcond
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoXmlClassMapping() {}
FdoXmlClassMapping(
@@ -148,6 +151,7 @@
FdoXmlElementMappingsP mElementMappings;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlClassMappingP is a FdoPtr on FdoXmlClassMapping, provided for convenience.
typedef FdoPtr<FdoXmlClassMapping> FdoXmlClassMappingP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ClassMappingCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ClassMappingCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ClassMappingCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -55,6 +55,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlClassMappingsP is a FdoPtr on FdoXmlClassMappingCollection, provided for convenience.
typedef FdoPtr<FdoXmlClassMappingCollection> FdoXmlClassMappingsP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/Context.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/Context.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/Context.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -30,19 +30,31 @@
/// \brief
/// Constructs a context for parsing FDO Deserializable items
///
- /// \param schemas
- /// Read the Feature Schemas into this collection.
+ /// \param flags
+ /// Input flags.
+ ///
+ /// \param xmlReader
+ /// Input xmlReader.
///
+ /// \return
+ /// Returns FdoXmlContext.
FDO_API static FdoXmlContext* Create( FdoXmlFlags* flags, FdoXmlReader* xmlReader );
/// \brief
/// Decodes any element name that was encoded to be XML-compatible.
///
+ /// \param name
+ /// Input name.
+ ///
+ /// \return
+ /// Returns FdoStringP.
FDO_API FdoStringP DecodeName ( FdoStringP name );
/// \brief
/// Retrieves the current XML flags.
///
+ /// \return
+ /// Returns FdoXmlFlags.
FDO_API FdoXmlFlags* GetFlags();
@@ -56,6 +68,9 @@
FdoXmlFlagsP mFlags;
};
+/// \ingroup (typedefs)
+/// \brief
+/// FdoXmlContextP is an FdoPtr on FdoXmlContext provided for convenience.
typedef FdoPtr<FdoXmlContext> FdoXmlContextP;
#endif
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/Deserializable.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/Deserializable.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/Deserializable.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -46,7 +46,7 @@
/// \brief
/// Reads an XML document from an XML reader.
///
- /// \param reader
+ /// \param xmlReader
/// Input the XML reader.
/// \param flags
/// Input controls the reading of the elements from the document.
@@ -60,7 +60,7 @@
/// \brief
/// Reads an XML document from a text reader.
///
- /// \param reader
+ /// \param textReader
/// Input the text reader. Must be positioned at the
/// start of an XML document.
/// \param flags
@@ -75,7 +75,7 @@
/// \brief
/// Reads an XML document from a stream.
///
- /// \param reader
+ /// \param stream
/// Input the stream. Must be positioned at the
/// start of an XML document.
/// \param flags
@@ -135,9 +135,9 @@
FDO_API virtual ~FdoXmlDeserializable();
private:
- /// current XML flags
+ // current XML flags
FdoXmlFlagsP mFlags;
- /// current XML reader
+ // current XML reader
FdoXmlReaderP mInternalReader;
};
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ElementMapping.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ElementMapping.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ElementMapping.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -107,7 +107,7 @@
/// \brief
/// Sets the namespace URI for this element.
///
- /// \param schemaName
+ /// \param gmlUri
/// Input a URI. Defaults to the targetNamespace
/// for the schema containing this element.
///
@@ -126,7 +126,7 @@
/// \brief
/// Sets the local name for this element.
///
- /// \param schemaName
+ /// \param gmlLocalName
/// Input the local name (unprefixed name) of this
/// element. Defaults to the element name.
///
@@ -146,6 +146,7 @@
/// Functions for XML support
/// \cond DOXYGEN-IGNORE
+//
/// \brief
/// Initializes this Xml Element Mapping from its XML attributes. Called when
/// the element is deserialized from XML.
@@ -184,8 +185,8 @@
virtual void SetChoiceName(FdoString* pChoiceName){m_choiceName = pChoiceName;}
virtual FdoString* GetChoiceName(){return m_choiceName;}
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoXmlElementMapping() {}
FdoXmlElementMapping(
@@ -207,6 +208,7 @@
FdoStringP m_choiceName;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlElementMappingP is a FdoPtr on FdoXmlElementMapping, provided for convenience.
typedef FdoPtr<FdoXmlElementMapping> FdoXmlElementMappingP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ElementMappingCollection.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ElementMappingCollection.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/ElementMappingCollection.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -44,8 +44,8 @@
///
FDO_API static FdoXmlElementMappingCollection* Create(FdoPhysicalElementMapping* parent);
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoXmlElementMappingCollection() : FdoPhysicalElementMappingCollection<FdoXmlElementMapping>()
{
}
@@ -61,6 +61,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlElementMappingsP is a FdoPtr on FdoXmlElementMappingCollection, provided for convenience.
typedef FdoPtr<FdoXmlElementMappingCollection> FdoXmlElementMappingsP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureContext.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureContext.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureContext.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -60,6 +60,7 @@
virtual ~FdoXmlFeatureContext();
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlFeatureContextP is a FdoPtr on FdoXmlFeatureContext, provided for convenience.
typedef FdoPtr<FdoXmlFeatureContext> FdoXmlFeatureContextP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureFlags.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureFlags.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureFlags.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -58,23 +58,18 @@
class FdoXmlFeatureFlags : public FdoXmlFlags
{
public:
- /// \brief
- /// The FdoXmlFeatureFlags::ConflictOption specifies how to handle features that
- /// are already in the DataStore, when Deserializing:
- ///
- /// \param ConflictOption_Add
- /// just add new features to the FDO DataStore. If a feature already exists, an
- /// exception is thrown.
- /// \param ConflictOption_Update
- /// Update the feature if it already exists, add it if it doesn't exist. This is
- /// the slowest option, since the feature must be queried from the DataStore before
- /// it is inserted or updated.
- /// \param ConflictOption_Skip
- /// just add new features. Silently skip features already in the DataStore.
- ///
+ /// \brief
+ /// The FdoXmlFeatureFlags::ConflictOption specifies how to handle features that
+ /// are already in the DataStore, when Deserializing:
enum ConflictOption {
+ /// Add new features to the FDO DataStore and if a feature already exists,
+ /// throw an exception.
ConflictOption_Add,
+ /// Update the feature if it already exists, add it if it doesn't exist.
+ /// This is the slowest option, since the feature must be queried from the DataStore
+ /// before it is inserted or updated.
ConflictOption_Update,
+ /// Add new features and silently skip features already in the DataStore.
ConflictOption_Skip
};
@@ -121,7 +116,7 @@
/// \brief
/// Sets the write feature collection flag. This flag is initially set to true.
///
- /// \param writeMember
+ /// \param writeCollection
/// Input
/// true: The serialized features are wrapped in a GML FeatureCollection element.
/// false: features are serialize without a wrapping collection element.
@@ -322,6 +317,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlFeatureFlagsP is a FdoPtr on FdoXmlFeatureFlags, provided for convenience.
typedef FdoPtr<FdoXmlFeatureFlags> FdoXmlFeatureFlagsP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureHandler.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureHandler.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureHandler.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -51,7 +51,7 @@
/// Returns the feature Handler for all sub-elements of the element that was current
/// when the read started. If NULL, this feature handler remains in effect.
///
- FDO_API virtual FdoXmlFeatureHandler* FeatureDocumentStart(FdoXmlFeatureContext*);
+ FDO_API virtual FdoXmlFeatureHandler* FeatureDocumentStart(FdoXmlFeatureContext* featureContext);
/// \brief
/// Default feature handler callback that is called when the
@@ -61,7 +61,7 @@
/// \param featureContext
/// Input caller specified contextual information
///
- FDO_API virtual void FeatureDocumentEnd(FdoXmlFeatureContext*);
+ FDO_API virtual void FeatureDocumentEnd(FdoXmlFeatureContext* featureContext);
/// \brief
/// Default feature handler callback that is called when the
@@ -71,11 +71,14 @@
/// \param featureContext
/// Input caller specified contextual information
///
+ /// \param classDefinition
+ /// Input class definition.
+ ///
/// \return
/// Returns the feature Handler for the features in this collection.
/// If NULL, this feature handler remains in effect.
///
- FDO_API virtual FdoXmlFeatureHandler* FeatureCollectionStart(FdoXmlFeatureContext*,FdoClassDefinition*);
+ FDO_API virtual FdoXmlFeatureHandler* FeatureCollectionStart(FdoXmlFeatureContext* featureContext, FdoClassDefinition* classDefinition);
/// \brief
/// Default feature handler callback that is called when the
@@ -90,7 +93,7 @@
/// to continue. Return value is ignored if the current parse is not an incremental
/// parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureCollectionEnd(FdoXmlFeatureContext*);
+ FDO_API virtual FdoBoolean FeatureCollectionEnd(FdoXmlFeatureContext* featureContext);
/// \brief
/// Default feature handler callback that is called when the
@@ -106,7 +109,7 @@
/// Returns the feature Handler for the feature's properties. If NULL, this feature
/// handler remains in effect.
///
- FDO_API virtual FdoXmlFeatureHandler* FeatureStart(FdoXmlFeatureContext*,FdoClassDefinition*);
+ FDO_API virtual FdoXmlFeatureHandler* FeatureStart(FdoXmlFeatureContext* featureContext, FdoClassDefinition* classDefinition);
/// \brief
/// Default feature handler callback that is called when the
@@ -120,7 +123,7 @@
/// parse to continue. Return value is ignored if the current parse is not an
/// incremental parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureEnd(FdoXmlFeatureContext*);
+ FDO_API virtual FdoBoolean FeatureEnd(FdoXmlFeatureContext* featureContext);
/// \brief
/// Default feature handler callback that is called when the
@@ -132,15 +135,15 @@
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
- /// Input property value
+ /// \param boolPropertyValue
+ /// Input value of boolean property.
///
/// \return
/// Returning true causes the current parse to stop. Returning false causes
/// the parse to continue. Return value is ignored if the current parse is not an
/// incremental parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext*, FdoString*, FdoBoolean);
+ FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext* featureContext, FdoString* name, FdoBoolean boolPropertyValue);
/// \brief
/// Default feature handler callback that is called when the
@@ -152,15 +155,15 @@
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
- /// Input property value
+ /// \param bytePropertyValue
+ /// Input byte property value
///
/// \return
/// Returning true causes the current parse to stop. Returning false causes
/// the parse to continue. Return value is ignored if the current parse is not an
/// incremental parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext*, FdoString*, FdoByte);
+ FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext* featureContext, FdoString* name, FdoByte bytePropertyValue);
/// \brief
/// Default feature handler callback that is called when the
@@ -172,15 +175,15 @@
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
- /// Input property value
+ /// \param dateTimePropertyValue
+ /// Input FdoDateTime property value
///
/// \return
/// Returning true causes the current parse to stop. Returning false causes
/// the parse to continue. Return value is ignored if the current parse is not an
/// incremental parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext*, FdoString*, FdoDateTime);
+ FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext* featureContext, FdoString* name, FdoDateTime dateTimePropertyValue);
/// \brief
/// Default feature handler callback that is called when the
@@ -192,15 +195,15 @@
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
- /// Input property value
+ /// \param doublePropertyValue
+ /// Input double property value
///
/// \return
/// Returning true causes the current parse to stop. Returning false causes
/// the parse to continue. Return value is ignored if the current parse is not an
/// incremental parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext*, FdoString*, FdoDouble);
+ FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext* featureContext, FdoString* name, FdoDouble doublePropertyValue);
/// \brief
/// Default feature handler callback that is called when the
@@ -212,15 +215,15 @@
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
- /// Input property value
+ /// \param int16PropertyValue
+ /// Input Int16 property value
///
/// \return
/// Returning true causes the current parse to stop. Returning false causes
/// the parse to continue. Return value is ignored if the current parse is not an
/// incremental parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext*, FdoString*, FdoInt16);
+ FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext* featureContext, FdoString* name, FdoInt16 int16PropertyValue);
/// \brief
/// Default feature handler callback that is called when the
@@ -232,15 +235,15 @@
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
- /// Input property value
+ /// \param int32PropertyValue
+ /// Input Int32 property value
///
/// \return
/// Returning true causes the current parse to stop. Returning false causes
/// the parse to continue. Return value is ignored if the current parse is not an
/// incremental parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext*, FdoString*, FdoInt32);
+ FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext* featureContext, FdoString* name, FdoInt32 int32PropertyValue);
/// \brief
/// Default feature handler callback that is called when the
@@ -252,15 +255,15 @@
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
- /// Input property value
+ /// \param int64PropertyValue
+ /// Input Int64 property value
///
/// \return
/// Returning true causes the current parse to stop. Returning false causes
/// the parse to continue. Return value is ignored if the current parse is not an
/// incremental parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext*, FdoString*, FdoInt64);
+ FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext* featureContext, FdoString* name, FdoInt64 int64PropertyValue);
/// \brief
/// Default feature handler callback that is called when the
@@ -272,15 +275,15 @@
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
- /// Input property value
+ /// \param floatPropertyValue
+ /// Input float property value
///
/// \return
/// Returning true causes the current parse to stop. Returning false causes
/// the parse to continue. Return value is ignored if the current parse is not an
/// incremental parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext*, FdoString*, FdoFloat);
+ FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext* featureContext, FdoString* name, FdoFloat floatPropertyValue);
/// \brief
/// Default feature handler callback that is called when the
@@ -292,15 +295,15 @@
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
- /// Input property value
+ /// \param stringPropertyValue
+ /// Input string property value
///
/// \return
/// Returning true causes the current parse to stop. Returning false causes
/// the parse to continue. Return value is ignored if the current parse is not an
/// incremental parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext*, FdoString*, FdoString*);
+ FDO_API virtual FdoBoolean FeatureProperty(FdoXmlFeatureContext* featureContext, FdoString* name, FdoString* stringPropertyValue);
/// \brief
/// Default feature handler callback that is called when the
@@ -313,7 +316,7 @@
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param raster
+ /// \param rasterPropertyValue
/// Input raster image properties. This object always has a NULL stream reader. The image is
/// handled by the FeatureBinaryData() callback.
///
@@ -322,7 +325,7 @@
/// parse to continue. Return value is ignored if the current parse is not an
/// incremental parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureStartRasterProperty(FdoXmlFeatureContext*, FdoString*, FdoIRaster*);
+ FDO_API virtual FdoBoolean FeatureStartRasterProperty(FdoXmlFeatureContext* featureContext, FdoString* name, FdoIRaster* rasterPropertyValue);
/// \brief
/// Default feature handler callback that is called when the
@@ -337,7 +340,7 @@
/// to continue. Return value is ignored if the current parse is not an incremental
/// parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureEndRasterProperty(FdoXmlFeatureContext*);
+ FDO_API virtual FdoBoolean FeatureEndRasterProperty(FdoXmlFeatureContext* featureContext);
/// \brief
/// Default feature handler callback that is called when the
@@ -356,7 +359,7 @@
/// to continue. Return value is ignored if the current parse is not an incremental
/// parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureStartLobProperty(FdoXmlFeatureContext*, FdoString*);
+ FDO_API virtual FdoBoolean FeatureStartLobProperty(FdoXmlFeatureContext* featureContext, FdoString* name);
/// \brief
/// Default feature handler callback that is called when the
@@ -371,7 +374,7 @@
/// to continue. Return value is ignored if the current parse is not an incremental
/// parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureEndLobProperty(FdoXmlFeatureContext*);
+ FDO_API virtual FdoBoolean FeatureEndLobProperty(FdoXmlFeatureContext* featureContext);
/// \brief
/// Default feature handler callback that is called when the
@@ -382,9 +385,9 @@
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param bytes
+ /// \param geometryByteArray
/// Input pointer to the byte array defining the geometry value
- /// \param count
+ /// \param byteCount
/// Input number of bytes in the byte array
///
/// \return
@@ -392,7 +395,7 @@
/// continue. Return value is ignored if the current parse is not an incremental
/// parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureGeometricProperty(FdoXmlFeatureContext*, FdoString*, FdoByte*, FdoInt32);
+ FDO_API virtual FdoBoolean FeatureGeometricProperty(FdoXmlFeatureContext* featureContext, FdoString*name, FdoByte* geometryByteArray, FdoInt32 byteCount);
/// \brief
/// Default feature handler callback that is called when the
@@ -410,7 +413,7 @@
/// Returns the feature Handler for the current object property's sub-properties.
/// If NULL, this feature handler remains in effect.
///
- FDO_API virtual FdoXmlFeatureHandler* FeatureStartObjectProperty(FdoXmlFeatureContext*, FdoString*, FdoClassDefinition*);
+ FDO_API virtual FdoXmlFeatureHandler* FeatureStartObjectProperty(FdoXmlFeatureContext* featureContext, FdoString* name, FdoClassDefinition* classDefinition);
/// \brief
/// Default feature handler callback that is called when the
@@ -425,7 +428,7 @@
/// to continue. Return value is ignored if the current parse is not an incremental
/// parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureEndObjectProperty(FdoXmlFeatureContext*);
+ FDO_API virtual FdoBoolean FeatureEndObjectProperty(FdoXmlFeatureContext* featureContext);
/// \brief
/// Default feature handler callback that is called when the
@@ -458,7 +461,7 @@
/// Returns the feature Handler for the current association property's sub-properties.
/// If NULL, this feature handler remains in effect.
///
- FDO_API virtual FdoXmlFeatureHandler* FeatureStartAssociationProperty(FdoXmlFeatureContext*, FdoString*, FdoClassDefinition*);
+ FDO_API virtual FdoXmlFeatureHandler* FeatureStartAssociationProperty(FdoXmlFeatureContext* featureContext, FdoString* name, FdoClassDefinition* classDefinition);
/// \brief
/// Default feature handler callback that is called when the
@@ -473,7 +476,7 @@
/// to continue. Return value is ignored if the current parse is not an incremental
/// parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureEndAssociationProperty(FdoXmlFeatureContext*);
+ FDO_API virtual FdoBoolean FeatureEndAssociationProperty(FdoXmlFeatureContext* featureContext);
/// \brief
/// Default Feature Handle callback that is called when the FdoXmlFeaturePropertyReader
@@ -492,7 +495,7 @@
/// to continue. Return value is ignored if the current parse is not an incremental
/// parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureCharacters(FdoXmlFeatureContext*, FdoString*);
+ FDO_API virtual FdoBoolean FeatureCharacters(FdoXmlFeatureContext* featureContext, FdoString* chars);
/// \brief
/// Default Feature callback that is called when the FdoXmlFeaturePropertyReader
@@ -515,7 +518,7 @@
/// to continue. Return value is ignored if the current parse is not an incremental
/// parse ( see FdoXmlFeaturePropertyReader::Parse())
///
- FDO_API virtual FdoBoolean FeatureBinaryData(FdoXmlFeatureContext*, FdoByte*, FdoSize);
+ FDO_API virtual FdoBoolean FeatureBinaryData(FdoXmlFeatureContext* featureContext, FdoByte* bytes, FdoSize count);
};
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeaturePropertyReader.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeaturePropertyReader.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeaturePropertyReader.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -147,6 +147,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlFeaturePropertyReaderP is a FdoPtr on FdoXmlFeaturePropertyReader, provided for convenience.
typedef FdoPtr<FdoXmlFeaturePropertyReader> FdoXmlFeaturePropertyReaderP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeaturePropertyWriter.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeaturePropertyWriter.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeaturePropertyWriter.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -81,7 +81,7 @@
/// element and the feature's actual element are written. The feature element name
/// is derived from the feature's class and schema names.
///
- /// \param stargTag
+ /// \param startTag
/// The start tag for the feature element. If it is null, the
/// feature's class name used.
///
@@ -102,7 +102,7 @@
/// \brief
/// Writes a feature property to XML.
///
- /// \param value
+ /// \param name
/// Input the property name
/// \param value
/// Input the property value as an FDO property
@@ -118,7 +118,7 @@
/// \brief
/// Writes a feature property to XML.
///
- /// \param value
+ /// \param name
/// Input the property name
/// \param value
/// Input the property value as a string
@@ -136,7 +136,7 @@
/// \brief
/// Writes a raster property to XML.
///
- /// \param value
+ /// \param name
/// Input the property name
/// \param value
/// Input the raster property value
@@ -152,7 +152,7 @@
/// \brief
/// Writes a lob property to XML.
///
- /// \param value
+ /// \param name
/// Input the property name
/// \param value
/// Input the lob property value
@@ -239,6 +239,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlFeaturePropertyReaderP is a FdoPtr on FdoXmlFeaturePropertyReader, provided for convenience.
typedef FdoPtr<FdoXmlFeaturePropertyWriter> FdoXmlFeaturePropertyWriterP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureReader.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureReader.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureReader.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -102,7 +102,7 @@
/// Normal.
/// </ul>
///
- /// \param value
+ /// \param schemas
/// Input the feature schemas
///
/// \return
@@ -112,6 +112,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlFeatureReaderP is a FdoPtr on FdoXmlFeatureReader, provided for convenience.
typedef FdoPtr<FdoXmlFeatureReader> FdoXmlFeatureReaderP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureWriter.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureWriter.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/FeatureWriter.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -103,7 +103,7 @@
/// \brief
/// Sets the class definition for the current feature being written.
///
- /// \param value
+ /// \param classDefinition
/// Input the class definition
///
/// \return
@@ -193,6 +193,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlFeatureWriterP is a FdoPtr on FdoXmlFeatureWriter, provided for convenience.
typedef FdoPtr<FdoXmlFeatureWriter> FdoXmlFeatureWriterP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/Flags.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/Flags.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/Flags.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -32,28 +32,6 @@
/// The FdoXmlFlags::ErrorLevel determines how strict the error reporting
/// is when a Feature Schema is read from an XML Document. For each errorLevel a
/// certain level of round-trip fidelity is guaranteed if the read succeeds.
- ///
- /// \param ErrorLevel_High
- /// the read fails with an exception when the
- /// Feature Schema cannot be read without alteration. If the Feature Schema
- /// is read successfully from document A and then written to document B,
- /// documents A and B are guaranteed to be identical. This errorLevel should be
- /// used when no alterations to the Feature Schema can be tolerated
- /// \param ErrorLevel_Normal
- /// fails if the Feature Schema cannot be read
- /// without changing the domain of its conforming instance documents. If the
- /// Feature Schema is read successfully from document A and then written to
- /// document B, any instance document that conforms to the document A schema
- /// will also conform to the document B schema. Any instance document that does
- /// not conform to A does not conform to B. However, documents A and B will not
- /// necessarily be identical.
- /// \param ErrorLevel_Low
- /// similar to ErrorLevel_Normal except that the
- /// instance document domain is allowed to grow. If the Feature Schema is read
- /// successfully from document A and then written to document B, any instance
- /// document that conforms to the document A schema will also conform to the
- /// document B schema. However a document that does not conform to the A schema
- /// may or may not conform to the B schema.
/// \param ErrorLevel_VeryLow
/// the read succeeds even if no level of
/// round-trip fidelity is maintained. If the Feature Schema is read successfully
@@ -65,9 +43,35 @@
/// altered during the read.
///
enum ErrorLevel {
+ /// The read fails with an exception when the Feature Schema cannot be read without alteration.
+ /// If the Feature Schema is read successfully from document A and then written to document B,
+ /// documents A and B are guaranteed to be identical.
+ /// This errorLevel should be used when no alterations to the Feature Schema can be tolerated
ErrorLevel_High,
+ /// Fails if the Feature Schema cannot be read
+ /// without changing the domain of its conforming instance documents.
+ /// If the Feature Schema is read successfully from document A
+ /// and then written to document B,
+ /// any instance document that conforms to the document A schema
+ /// will also conform to the document B schema.
+ /// Any instance document that does not conform to A does not conform to B.
+ /// However, documents A and B will not necessarily be identical.
ErrorLevel_Normal,
+ /// Similar to ErrorLevel_Normal except that the
+ /// instance document domain is allowed to grow.
+ /// If the Feature Schema is read
+ /// successfully from document A and then written to document B,
+ /// any instance document that conforms to the document A schema will also conform to the document B schema.
+ /// However a document that does not conform to the A schema
+ /// may or may not conform to the B schema.
ErrorLevel_Low,
+ /// The read succeeds even if no level of round-trip fidelity is maintained.
+ /// If the Feature Schema is read successfully from document A and then written to document B,
+ /// any instance document thatconforms to the document A schema
+ /// may or may not conform to the document B schema.
+ /// A document that does not conform to the A schema may or may not conform to the B schema.
+ /// This errorLevel is useful for reading schemas from external sources into FDO
+ /// when it doesn’t matter how much the schemas are altered during the read.
ErrorLevel_VeryLow
};
@@ -113,7 +117,7 @@
/// \brief
/// Sets the error level, see FdoXmlFlags::Create().
///
- /// \param url
+ /// \param errorLevel
/// Input the error level.
///
FDO_API void SetErrorLevel( ErrorLevel errorLevel );
@@ -129,7 +133,7 @@
/// \brief
/// Sets the name adjustment flag, see FdoXmlFlags::Create().
///
- /// \param url
+ /// \param nameAdjust
/// Input the name adjustment flag.
///
FDO_API void SetNameAdjust( FdoBoolean nameAdjust );
@@ -247,6 +251,7 @@
/// \endcond
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlFlagsP is a FdoPtr on FdoXmlFlags, provided for convenience.
typedef FdoPtr<FdoXmlFlags> FdoXmlFlagsP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/NameCollectionHandler.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/NameCollectionHandler.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/NameCollectionHandler.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -58,7 +58,7 @@
virtual void _writeXml(FdoXmlWriter* xmlWriter, const FdoXmlFlags* flags);
virtual FdoXmlSaxHandler* XmlStartElement(
- FdoXmlSaxContext* context,
+ FdoXmlSaxContext* saxContext,
FdoString* uri,
FdoString* name,
FdoString* qname,
@@ -66,7 +66,7 @@
);
virtual FdoBoolean XmlEndElement(
- FdoXmlSaxContext* context,
+ FdoXmlSaxContext* saxContext,
FdoString* uri,
FdoString* name,
FdoString* qname
@@ -87,6 +87,7 @@
FdoXmlSkipElementHandlerP mXmlSkipper;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlNameCollectionHandlerP is a FdoPtr on FdoXmlNameCollectionHandler, provided for convenience.
typedef FdoPtr<FdoXmlNameCollectionHandler> FdoXmlNameCollectionHandlerP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SchemaMapping.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SchemaMapping.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SchemaMapping.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -97,8 +97,8 @@
///
FDO_API FdoXmlClassMappingCollection* GetClassMappings();
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
FdoXmlSchemaMapping() {}
FdoXmlSchemaMapping( FdoString* name );
@@ -147,6 +147,7 @@
FdoXmlClassMappingsP mClassMappings;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlSchemaMappingP is a FdoPtr on FdoXmlSchemaMapping, provided for convenience.
typedef FdoPtr<FdoXmlSchemaMapping> FdoXmlSchemaMappingP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SpatialContextFlags.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SpatialContextFlags.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SpatialContextFlags.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -31,25 +31,20 @@
class FdoXmlSpatialContextFlags : public FdoXmlFlags
{
public:
- /// \brief
- /// The FdoXmlSpatialContextFlags::ConflictOption specifies how
- /// to handle Spatial Contexts that are already in the DataStore,
- /// when Deserializing:
- ///
- /// \param ConflictOption_Add
- /// just add new spatial contexts to the
- /// FDO DataStore. If the Spatial Context already exists, an exception
- /// is thrown.
- /// \param ConflictOption_Update
- /// Update the spatial context if it already
- /// exists, add it if it doesn't exist.
- /// \param ConflictOption_Skip
- /// just add new spatial contexts.
- /// Silently skip spatial contexts already in the DataStore.
- ///
+ /// \brief
+ /// The FdoXmlSpatialContextFlags::ConflictOption specifies how
+ /// to handle Spatial Contexts that are already in the DataStore,
+ /// when Deserializing:
enum ConflictOption {
+ /// Add new spatial contexts to the FDO DataStore and
+ /// if the Spatial Context already exists, throw an exception.
+ /// is thrown.
ConflictOption_Add,
+ /// Update the spatial context if it already exists and
+ /// add it if it doesn't exist.
ConflictOption_Update,
+ /// Add new spatial contexts and
+ /// silently skip spatial contexts already in the DataStore.
ConflictOption_Skip
};
@@ -139,6 +134,7 @@
FdoBoolean mIncludeDefault;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlSpatialContextFlagsP is a FdoPtr on FdoXmlSpatialContextFlags, provided for convenience.
typedef FdoPtr<FdoXmlSpatialContextFlags> FdoXmlSpatialContextFlagsP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SpatialContextReader.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SpatialContextReader.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SpatialContextReader.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -118,9 +118,6 @@
/// Gets the extent of the spatial context currently being read as a byte
/// array in FGF format.
///
- /// \param length
- /// Output the length of the returned byte array.
- ///
/// \return
/// Returns the extent as a byte array in FGF format.
///
@@ -171,12 +168,12 @@
///
FDO_API virtual bool ReadNext();
- FDO_API virtual FdoXmlSaxHandler* XmlStartDocument(FdoXmlSaxContext*);
+ FDO_API virtual FdoXmlSaxHandler* XmlStartDocument(FdoXmlSaxContext* saxContext);
/// The following callbacks catch the start element and end element
/// SAX events.
FDO_API virtual FdoXmlSaxHandler* XmlStartElement(
- FdoXmlSaxContext* context,
+ FdoXmlSaxContext* saxContext,
FdoString* uri,
FdoString* name,
FdoString* qname,
@@ -184,7 +181,7 @@
);
FDO_API virtual FdoBoolean XmlEndElement(
- FdoXmlSaxContext* context,
+ FdoXmlSaxContext* saxContext,
FdoString* uri,
FdoString* name,
FdoString* qname
@@ -219,6 +216,7 @@
FdoXmlSCReadHandler* mSCHandler;
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlSpatialContextReaderP is a FdoPtr on FdoXmlSpatialContextReader, provided for convenience.
typedef FdoPtr<FdoXmlSpatialContextReader> FdoXmlSpatialContextReaderP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SpatialContextWriter.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SpatialContextWriter.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Fdo/Xml/SpatialContextWriter.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -262,6 +262,7 @@
};
+/// \ingroup (typedefs)
/// \brief
/// FdoXmlSpatialContextWriterP is a FdoPtr on FdoXmlSpatialContextWriter, provided for convenience.
typedef FdoPtr<FdoXmlSpatialContextWriter> FdoXmlSpatialContextWriterP;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Geometry/DirectPositionImpl.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Geometry/DirectPositionImpl.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Geometry/DirectPositionImpl.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -35,8 +35,8 @@
class FdoDirectPositionImpl : public FdoIDirectPosition
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// Constructors
/// \brief
@@ -415,9 +415,9 @@
///
FDO_GEOM_API void SetDimensionality(FdoInt32 dimensionality);
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
void Dispose();
double m_x;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Geometry/EnvelopeImpl.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Geometry/EnvelopeImpl.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Geometry/EnvelopeImpl.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -34,8 +34,8 @@
class FdoEnvelopeImpl : public FdoIEnvelope
{
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
/// \brief
/// Constructs a default instance of a FdoEnvelopeImpl object.
///
@@ -398,9 +398,9 @@
///
FDO_GEOM_API void Expand(FdoIEnvelope* envelope);
+/// \cond DOXYGEN-IGNORE
protected:
-/// \cond DOXYGEN-IGNORE
void Dispose();
double m_minX;
Modified: branches/3.2.x/Fdo/Unmanaged/Inc/Spatial/SpatialGeometryValidity.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Spatial/SpatialGeometryValidity.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Spatial/SpatialGeometryValidity.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -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: branches/3.2.x/Fdo/Unmanaged/Inc/Spatial/SpatialGridTransform.h
===================================================================
--- branches/3.2.x/Fdo/Unmanaged/Inc/Spatial/SpatialGridTransform.h 2007-02-14 21:40:51 UTC (rev 773)
+++ branches/3.2.x/Fdo/Unmanaged/Inc/Spatial/SpatialGridTransform.h 2007-02-14 21:48:31 UTC (rev 774)
@@ -114,6 +114,7 @@
virtual ~FdoSpatialGridTransform();
};
+/// \ingroup (typedefs)
/// \brief
/// FdoSpatialGridTransformP is a FdoPtr on FdoSpatialGridTransform, provided for convenience.
typedef FdoPtr<FdoSpatialGridTransform> FdoSpatialGridTransformP;
More information about the fdo-commits
mailing list