[fdo-commits] r2525 - in trunk/Fdo/Unmanaged/Inc/Fdo/Connections: .
Capabilities
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Thu Feb 15 14:45:13 EST 2007
Author: gregboone
Date: 2007-02-15 14:45:13 -0500 (Thu, 15 Feb 2007)
New Revision: 2525
Modified:
trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ArgumentDefinition.h
trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/FunctionDefinition.h
trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ISchemaCapabilities.h
trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SchemaElementNameType.h
trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SignatureDefinition.h
trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ThreadCapability.h
trunk/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionException.h
trunk/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionState.h
trunk/Fdo/Unmanaged/Inc/Fdo/Connections/ProviderDatastoreType.h
Log:
FDO4: API - Update API documentation included in the FDO header files
Modified: trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ArgumentDefinition.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ArgumentDefinition.h 2007-02-15 19:43:43 UTC (rev 2524)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ArgumentDefinition.h 2007-02-15 19:45:13 UTC (rev 2525)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/FunctionDefinition.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/FunctionDefinition.h 2007-02-15 19:43:43 UTC (rev 2524)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/FunctionDefinition.h 2007-02-15 19:45:13 UTC (rev 2525)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ISchemaCapabilities.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ISchemaCapabilities.h 2007-02-15 19:43:43 UTC (rev 2524)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ISchemaCapabilities.h 2007-02-15 19:45:13 UTC (rev 2525)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SchemaElementNameType.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SchemaElementNameType.h 2007-02-15 19:43:43 UTC (rev 2524)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SchemaElementNameType.h 2007-02-15 19:45:13 UTC (rev 2525)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SignatureDefinition.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SignatureDefinition.h 2007-02-15 19:43:43 UTC (rev 2524)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/SignatureDefinition.h 2007-02-15 19:45:13 UTC (rev 2525)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ThreadCapability.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ThreadCapability.h 2007-02-15 19:43:43 UTC (rev 2524)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Connections/Capabilities/ThreadCapability.h 2007-02-15 19:45:13 UTC (rev 2525)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionException.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionException.h 2007-02-15 19:43:43 UTC (rev 2524)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionException.h 2007-02-15 19:45:13 UTC (rev 2525)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionState.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionState.h 2007-02-15 19:43:43 UTC (rev 2524)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Connections/ConnectionState.h 2007-02-15 19:45:13 UTC (rev 2525)
@@ -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: trunk/Fdo/Unmanaged/Inc/Fdo/Connections/ProviderDatastoreType.h
===================================================================
--- trunk/Fdo/Unmanaged/Inc/Fdo/Connections/ProviderDatastoreType.h 2007-02-15 19:43:43 UTC (rev 2524)
+++ trunk/Fdo/Unmanaged/Inc/Fdo/Connections/ProviderDatastoreType.h 2007-02-15 19:45:13 UTC (rev 2525)
@@ -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
{
More information about the fdo-commits
mailing list