[fdo-commits] r2523 - trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices

[svn_fdo at osgeo.org]

Author: gregboone
Date: 2007-02-15 14:41:37 -0500 (Thu, 15 Feb 2007)
New Revision: 2523

Modified:
   trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ClientServiceException.h
   trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ConnectionManager.h
   trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/Provider.h
   trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderCollection.h
   trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderNameTokens.h
   trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderRegistry.h
Log:
FDO4: API - Update API documentation included in the FDO header files

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ClientServiceException.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ClientServiceException.h	2007-02-15 19:27:16 UTC (rev 2522)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ClientServiceException.h	2007-02-15 19:41:37 UTC (rev 2523)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ConnectionManager.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ConnectionManager.h	2007-02-15 19:27:16 UTC (rev 2522)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ConnectionManager.h	2007-02-15 19:41:37 UTC (rev 2523)
@@ -55,8 +55,8 @@
     /// 
     friend class FdoFeatureAccessManager;
 
+/// \cond DOXYGEN-IGNORE
 protected:
-/// \cond DOXYGEN-IGNORE
     /// Constructs a default instance of a FdoProviderRegistry object.
     FdoConnectionManager();
 

Modified: trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/Provider.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/Provider.h	2007-02-15 19:27:16 UTC (rev 2522)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/Provider.h	2007-02-15 19:41:37 UTC (rev 2523)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderCollection.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderCollection.h	2007-02-15 19:27:16 UTC (rev 2522)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderCollection.h	2007-02-15 19:41:37 UTC (rev 2523)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderNameTokens.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderNameTokens.h	2007-02-15 19:27:16 UTC (rev 2522)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderNameTokens.h	2007-02-15 19:41:37 UTC (rev 2523)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderRegistry.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderRegistry.h	2007-02-15 19:27:16 UTC (rev 2522)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/ClientServices/ProviderRegistry.h	2007-02-15 19:41:37 UTC (rev 2523)
@@ -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();