[fdo-commits] r2524 - in trunk/Fdo/Unmanaged/Inc/Fdo/Commands: . Locking LongTransaction Schema SpatialContext Sql UnitOfMeasure

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


Author: gregboone
Date: 2007-02-15 14:43:43 -0500 (Thu, 15 Feb 2007)
New Revision: 2524

Modified:
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/CommandException.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/CommandType.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/IdentifierCollection.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/ConflictType.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockStrategy.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockType.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionConflictResolution.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionFreezeOperations.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivilegeOperations.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivileges.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionSetOperations.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/OrderingOption.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/ParameterValue.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValue.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValueCollection.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalClassMapping.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMapping.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMappingCollection.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalPropertyMapping.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMapping.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMappingCollection.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/ISpatialContextReader.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextExtentType.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextMismatchException.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Sql/ISQLDataReader.h
   trunk/Fdo/Unmanaged/Inc/Fdo/Commands/UnitOfMeasure/BaseUnit.h
Log:
FDO4: API - Update API documentation included in the FDO header files

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/CommandException.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/CommandException.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/CommandException.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/CommandType.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/CommandType.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/CommandType.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -23,169 +23,10 @@
 #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. Autodesk 
-/// 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{
     /// Represents the Select Command.
     FdoCommandType_Select,

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/IdentifierCollection.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/IdentifierCollection.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/IdentifierCollection.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/ConflictType.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/ConflictType.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/ConflictType.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockStrategy.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockStrategy.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockStrategy.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockType.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockType.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Locking/LockType.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionConflictResolution.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionConflictResolution.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionConflictResolution.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionFreezeOperations.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionFreezeOperations.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionFreezeOperations.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivilegeOperations.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivilegeOperations.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivilegeOperations.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivileges.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivileges.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionPrivileges.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionSetOperations.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionSetOperations.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/LongTransaction/LongTransactionSetOperations.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/OrderingOption.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/OrderingOption.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/OrderingOption.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/ParameterValue.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/ParameterValue.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/ParameterValue.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValue.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValue.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValue.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValueCollection.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValueCollection.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/PropertyValueCollection.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalClassMapping.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalClassMapping.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalClassMapping.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -100,6 +100,7 @@
 
 };
 
+/// \ingroup (typedefs)
 /// \brief
 /// FdoPhysicalClassMappingP is a FdoPtr on FdoPhysicalClassMapping, provided for convenience.
 typedef FdoPtr<FdoPhysicalClassMapping> FdoPhysicalClassMappingP;

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMapping.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMapping.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMapping.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMappingCollection.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMappingCollection.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalElementMappingCollection.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalPropertyMapping.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalPropertyMapping.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalPropertyMapping.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -98,6 +98,7 @@
 
 };
 
+/// \ingroup (typedefs)
 /// \brief
 /// FdoPhysicalPropertyMappingP is a FdoPtr on FdoPhysicalPropertyMapping, provided for convenience.
 typedef FdoPtr<FdoPhysicalPropertyMapping> FdoPhysicalPropertyMappingP;

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMapping.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMapping.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMapping.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -90,6 +90,7 @@
 
 };
 
+/// \ingroup (typedefs)
 /// \brief
 /// FdoIPhysicalSchemaMappingP is a FdoPtr on FdoIPhysicalSchemaMapping, provided for convenience.
 typedef FdoPtr<FdoPhysicalSchemaMapping> FdoPhysicalSchemaMappingP;

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMappingCollection.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMappingCollection.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Schema/PhysicalSchemaMappingCollection.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/ISpatialContextReader.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/ISpatialContextReader.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/ISpatialContextReader.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextExtentType.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextExtentType.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextExtentType.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextMismatchException.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextMismatchException.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/SpatialContext/SpatialContextMismatchException.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Sql/ISQLDataReader.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Sql/ISQLDataReader.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/Sql/ISQLDataReader.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Commands/UnitOfMeasure/BaseUnit.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Commands/UnitOfMeasure/BaseUnit.h	2007-02-15 19:41:37 UTC (rev 2523)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Commands/UnitOfMeasure/BaseUnit.h	2007-02-15 19:43:43 UTC (rev 2524)
@@ -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



More information about the fdo-commits mailing list