[fdo-commits] r2597 - in trunk/Fdo/Docs/doc_src: .
group_and_page_definitions headers_and_footers
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Thu Feb 22 16:36:26 EST 2007
Author: gregboone
Date: 2007-02-22 16:36:26 -0500 (Thu, 22 Feb 2007)
New Revision: 2597
Added:
trunk/Fdo/Docs/doc_src/group_and_page_definitions/chm_usage_notes
trunk/Fdo/Docs/doc_src/group_and_page_definitions/define_pages_managed.h
trunk/Fdo/Docs/doc_src/headers_and_footers/footer_managed.html
trunk/Fdo/Docs/doc_src/headers_and_footers/header_managed.html
Modified:
trunk/Fdo/Docs/doc_src/Doxyfile_FDOmanaged
trunk/Fdo/Docs/doc_src/Doxyfile_FDOunmanaged
trunk/Fdo/Docs/doc_src/group_and_page_definitions/Makefile.am
trunk/Fdo/Docs/doc_src/group_and_page_definitions/define_pages.h
trunk/Fdo/Docs/doc_src/headers_and_footers/Makefile.am
Log:
FDO4: Update API documentation generation process
Modified: trunk/Fdo/Docs/doc_src/Doxyfile_FDOmanaged
===================================================================
--- trunk/Fdo/Docs/doc_src/Doxyfile_FDOmanaged 2007-02-22 20:53:22 UTC (rev 2596)
+++ trunk/Fdo/Docs/doc_src/Doxyfile_FDOmanaged 2007-02-22 21:36:26 UTC (rev 2597)
@@ -68,12 +68,13 @@
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text"
-WARN_LOGFILE = warning_logfile.txt
+WARN_LOGFILE = warning_logfile_managed.txt
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = ../../Managed/src \
- group_and_page_definitions/define_pages.h
+ group_and_page_definitions/chm_usage_notes \
+ group_and_page_definitions/define_pages_managed.h
FILE_PATTERNS = *.h
RECURSIVE = YES
EXCLUDE =
@@ -83,7 +84,7 @@
VirtualFdoIoStream.h \
resource.h \
ProtocolExt.h \
- define_pages.h
+ define_pages_managed.h
EXAMPLE_PATH = headers_and_footers
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = YES
@@ -106,7 +107,7 @@
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
-COLS_IN_ALPHA_INDEX = 5
+COLS_IN_ALPHA_INDEX = 1
IGNORE_PREFIX = Fdo \
Mg
#---------------------------------------------------------------------------
@@ -114,9 +115,9 @@
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = ../HTML/FDO_API_managed
-HTML_FILE_EXTENSION = .html
-HTML_HEADER = headers_and_footers/header.html
-HTML_FOOTER = headers_and_footers/footer.html
+HTML_FILE_EXTENSION = .htm
+HTML_HEADER = headers_and_footers/header_managed.html
+HTML_FOOTER = headers_and_footers/footer_managed.html
HTML_STYLESHEET = headers_and_footers/custom.css
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = YES
@@ -126,7 +127,7 @@
BINARY_TOC = YES
TOC_EXPAND = YES
DISABLE_INDEX = NO
-ENUM_VALUES_PER_LINE = 4
+ENUM_VALUES_PER_LINE = 1
GENERATE_TREEVIEW = YES
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
@@ -188,7 +189,99 @@
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
-PREDEFINED =
+PREDEFINED = "BEGIN_NAMESPACE_OSGEO=namespace OSGeo {" \
+ "END_NAMESPACE_OSGEO=}" \
+ "BEGIN_NAMESPACE_OSGEO_FDO=BEGIN_NAMESPACE_OSGEO namespace FDO {" \
+ "END_NAMESPACE_OSGEO_FDO=END_NAMESPACE_OSGEO }" \
+ "BEGIN_NAMESPACE_OSGEO_RUNTIME=BEGIN_NAMESPACE_OSGEO_FDO namespace Runtime {" \
+ "END_NAMESPACE_OSGEO_RUNTIME=END_NAMESPACE_OSGEO_FDO }" \
+ "BEGIN_NAMESPACE_OSGEO_COMMON=BEGIN_NAMESPACE_OSGEO_FDO namespace Common {" \
+ "END_NAMESPACE_OSGEO_COMMON=END_NAMESPACE_OSGEO_FDO }" \
+ "BEGIN_NAMESPACE_OSGEO_COMMON_IO=BEGIN_NAMESPACE_OSGEO_COMMON namespace Io {" \
+ "END_NAMESPACE_OSGEO_COMMON_IO=END_NAMESPACE_OSGEO_COMMON }" \
+ "BEGIN_NAMESPACE_OSGEO_COMMON_XML=BEGIN_NAMESPACE_OSGEO_COMMON namespace Xml {" \
+ "END_NAMESPACE_OSGEO_COMMON_XML=END_NAMESPACE_OSGEO_COMMON }" \
+ "BEGIN_NAMESPACE_OSGEO_COMMON_XSL=BEGIN_NAMESPACE_OSGEO_COMMON namespace Xsl {" \
+ "END_NAMESPACE_OSGEO_COMMON_XSL=END_NAMESPACE_OSGEO_COMMON }" \
+ "BEGIN_NAMESPACE_OSGEO_COMMON_GML212=BEGIN_NAMESPACE_OSGEO_COMMON namespace Gml212 {" \
+ "END_NAMESPACE_OSGEO_COMMON_GML212=END_NAMESPACE_OSGEO_COMMON }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_XML=BEGIN_NAMESPACE_OSGEO_FDO namespace Xml {" \
+ "END_NAMESPACE_OSGEO_FDO_XML=END_NAMESPACE_OSGEO_FDO }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS=BEGIN_NAMESPACE_OSGEO_FDO namespace Connections {" \
+ "END_NAMESPACE_OSGEO_FDO_CONNECTIONS=END_NAMESPACE_OSGEO_FDO }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS=BEGIN_NAMESPACE_OSGEO_FDO namespace Commands {" \
+ "END_NAMESPACE_OSGEO_FDO_COMMANDS=END_NAMESPACE_OSGEO_FDO }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_SCHEMA=BEGIN_NAMESPACE_OSGEO_FDO namespace Schema {" \
+ "END_NAMESPACE_OSGEO_FDO_SCHEMA=END_NAMESPACE_OSGEO_FDO }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA=BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS namespace Schema {" \
+ "END_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA=END_NAMESPACE_OSGEO_FDO_COMMANDS }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION=BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS namespace LongTransaction {" \
+ "END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION=END_NAMESPACE_OSGEO_FDO_COMMANDS }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE=BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS namespace Feature {" \
+ "END_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE=END_NAMESPACE_OSGEO_FDO_COMMANDS }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING=BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS namespace Locking {" \
+ "END_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING=END_NAMESPACE_OSGEO_FDO_COMMANDS }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SQL=BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS namespace SQL {" \
+ "END_NAMESPACE_OSGEO_FDO_COMMANDS_SQL=END_NAMESPACE_OSGEO_FDO_COMMANDS }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE=BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS namespace UnitOfMeasure {" \
+ "END_NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE=END_NAMESPACE_OSGEO_FDO_COMMANDS }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT=BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS namespace SpatialContext {" \
+ "END_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT=END_NAMESPACE_OSGEO_FDO_COMMANDS }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_NETWORK=BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS namespace Network {" \
+ "END_NAMESPACE_OSGEO_FDO_COMMANDS_NETWORK=END_NAMESPACE_OSGEO_FDO_COMMANDS }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_TOPOLOGY=BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS namespace Topology {" \
+ "END_NAMESPACE_OSGEO_FDO_COMMANDS_TOPOLOGY=END_NAMESPACE_OSGEO_FDO_COMMANDS }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE=BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS namespace DataStore {" \
+ "END_NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE=END_NAMESPACE_OSGEO_FDO_COMMANDS }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_EXPRESSION=BEGIN_NAMESPACE_OSGEO_FDO namespace Expression {" \
+ "END_NAMESPACE_OSGEO_FDO_EXPRESSION=END_NAMESPACE_OSGEO_FDO }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS=BEGIN_NAMESPACE_OSGEO_FDO namespace Connections {" \
+ "END_NAMESPACE_OSGEO_FDO_CONNECTIONS=END_NAMESPACE_OSGEO_FDO }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES=BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS namespace Capabilities {" \
+ "END_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES=END_NAMESPACE_OSGEO_FDO_CONNECTIONS }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_FILTER=BEGIN_NAMESPACE_OSGEO_FDO namespace Filter {" \
+ "END_NAMESPACE_OSGEO_FDO_FILTER=END_NAMESPACE_OSGEO_FDO }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_RASTER=BEGIN_NAMESPACE_OSGEO_FDO namespace Raster {" \
+ "END_NAMESPACE_OSGEO_FDO_RASTER=END_NAMESPACE_OSGEO_FDO }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_CLIENTSERVICES=BEGIN_NAMESPACE_OSGEO_FDO namespace ClientServices {" \
+ "END_NAMESPACE_OSGEO_FDO_CLIENTSERVICES=END_NAMESPACE_OSGEO_FDO }" \
+ "BEGIN_NAMESPACE_OSGEO_FDO_PROVIDERS=BEGIN_NAMESPACE_OSGEO_FDO namespace Providers {" \
+ "END_NAMESPACE_OSGEO_FDO_PROVIDERS=END_NAMESPACE_OSGEO_FDO }" \
+ "BEGIN_NAMESPACE_OSGEO_GEOMETRY=BEGIN_NAMESPACE_OSGEO_FDO namespace Geometry {" \
+ "END_NAMESPACE_OSGEO_GEOMETRY=END_NAMESPACE_OSGEO_FDO }" \
+ "BEGIN_NAMESPACE_OSGEO_SPATIAL=BEGIN_NAMESPACE_OSGEO_FDO namespace Spatial {" \
+ "END_NAMESPACE_OSGEO_SPATIAL=END_NAMESPACE_OSGEO_FDO }" \
+ "NAMESPACE_OSGEO=OSGeo" \
+ "NAMESPACE_OSGEO_FDO=NAMESPACE_OSGEO::FDO" \
+ "NAMESPACE_OSGEO_RUNTIME=NAMESPACE_OSGEO_FDO::Runtime" \
+ "NAMESPACE_OSGEO_COMMON=NAMESPACE_OSGEO_FDO::Common" \
+ "NAMESPACE_OSGEO_COMMON_IO=NAMESPACE_OSGEO_COMMON::Io" \
+ "NAMESPACE_OSGEO_COMMON_XML=NAMESPACE_OSGEO_COMMON::Xml" \
+ "NAMESPACE_OSGEO_COMMON_XSL=NAMESPACE_OSGEO_COMMON::Xsl" \
+ "NAMESPACE_OSGEO_COMMON_GML212=NAMESPACE_OSGEO_COMMON::Gml212" \
+ "NAMESPACE_OSGEO_FDO_XML=NAMESPACE_OSGEO_FDO::Xml" \
+ "NAMESPACE_OSGEO_FDO_SCHEMA=NAMESPACE_OSGEO_FDO::Schema" \
+ "NAMESPACE_OSGEO_FDO_COMMANDS=NAMESPACE_OSGEO_FDO::Commands" \
+ "NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA=NAMESPACE_OSGEO_FDO_COMMANDS::Schema" \
+ "NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION=NAMESPACE_OSGEO_FDO_COMMANDS::LongTransaction" \
+ "NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE=NAMESPACE_OSGEO_FDO_COMMANDS::Feature" \
+ "NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING=NAMESPACE_OSGEO_FDO_COMMANDS::Locking" \
+ "NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE=NAMESPACE_OSGEO_FDO_COMMANDS::UnitOfMeasure" \
+ "NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT=NAMESPACE_OSGEO_FDO_COMMANDS::SpatialContext" \
+ "NAMESPACE_OSGEO_FDO_COMMANDS_TOPOLOGY=NAMESPACE_OSGEO_FDO_COMMANDS::Topology" \
+ "NAMESPACE_OSGEO_FDO_COMMANDS_NETWORK=NAMESPACE_OSGEO_FDO_COMMANDS::Network" \
+ "NAMESPACE_OSGEO_FDO_COMMANDS_SQL=NAMESPACE_OSGEO_FDO_COMMANDS::SQL" \
+ "NAMESPACE_OSGEO_FDO_COMMANDS_DATASTORE=NAMESPACE_OSGEO_FDO_COMMANDS::DataStore" \
+ "NAMESPACE_OSGEO_FDO_EXPRESSION=NAMESPACE_OSGEO_FDO::Expression" \
+ "NAMESPACE_OSGEO_FDO_CONNECTIONS=NAMESPACE_OSGEO_FDO::Connections" \
+ "NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES=NAMESPACE_OSGEO_FDO_CONNECTIONS::Capabilities" \
+ "NAMESPACE_OSGEO_FDO_FILTER=NAMESPACE_OSGEO_FDO::Filter" \
+ "NAMESPACE_OSGEO_FDO_RASTER=NAMESPACE_OSGEO_FDO::Raster" \
+ "NAMESPACE_OSGEO_FDO_CLIENTSERVICES=NAMESPACE_OSGEO_FDO::ClientServices" \
+ "NAMESPACE_OSGEO_FDO_PROVIDERS=NAMESPACE_OSGEO_FDO::Providers" \
+ "NAMESPACE_OSGEO_GEOMETRY=NAMESPACE_OSGEO_FDO::Geometry" \
+ "NAMESPACE_OSGEO_SPATIAL=NAMESPACE_OSGEO_FDO::Spatial"
+
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
Modified: trunk/Fdo/Docs/doc_src/Doxyfile_FDOunmanaged
===================================================================
--- trunk/Fdo/Docs/doc_src/Doxyfile_FDOunmanaged 2007-02-22 20:53:22 UTC (rev 2596)
+++ trunk/Fdo/Docs/doc_src/Doxyfile_FDOunmanaged 2007-02-22 21:36:26 UTC (rev 2597)
@@ -1,4 +1,4 @@
-# Doxyfile 1.4.6
+# Doxyfile 1.5.1
#---------------------------------------------------------------------------
# Project related configuration options
@@ -63,10 +63,10 @@
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
-WARNINGS = NO
-WARN_IF_UNDOCUMENTED = NO
-WARN_IF_DOC_ERROR = NO
-WARN_NO_PARAMDOC = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_IF_DOC_ERROR = YES
+WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE = warning_logfile.txt
#---------------------------------------------------------------------------
@@ -79,7 +79,8 @@
EXCLUDE = ../../Unmanaged/Inc/Spatial/SpatialGridTransform.h \
../../Unmanaged/Inc/Spatial/SpatialStd.h \
../../Unmanaged/Inc/Spatial/SpatialUtility.h \
- ../../Unmanaged/Inc/Spatial/SpatialGeometryValidity.h
+ ../../Unmanaged/Inc/Spatial/SpatialGeometryValidity.h \
+ ../../Unmanaged/Inc/Fdo/Raster/DataValueCollection.h
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXAMPLE_PATH = headers_and_footers
@@ -103,14 +104,14 @@
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
-COLS_IN_ALPHA_INDEX = 5
+COLS_IN_ALPHA_INDEX = 2
IGNORE_PREFIX = Fdo
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = ../HTML/FDO_API
-HTML_FILE_EXTENSION = .html
+HTML_FILE_EXTENSION = .htm
HTML_HEADER = headers_and_footers/header.html
HTML_FOOTER = headers_and_footers/footer.html
HTML_STYLESHEET = headers_and_footers/custom.css
@@ -120,9 +121,9 @@
HHC_LOCATION = "C:/Program Files/HTML Help Workshop/hhc.exe"
GENERATE_CHI = NO
BINARY_TOC = YES
-TOC_EXPAND = NO
+TOC_EXPAND = YES
DISABLE_INDEX = NO
-ENUM_VALUES_PER_LINE = 4
+ENUM_VALUES_PER_LINE = 1
GENERATE_TREEVIEW = YES
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
@@ -180,11 +181,11 @@
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
-EXPAND_ONLY_PREDEF = NO
+EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
-PREDEFINED =
+PREDEFINED = __cplusplus
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
Modified: trunk/Fdo/Docs/doc_src/group_and_page_definitions/Makefile.am
===================================================================
--- trunk/Fdo/Docs/doc_src/group_and_page_definitions/Makefile.am 2007-02-22 20:53:22 UTC (rev 2596)
+++ trunk/Fdo/Docs/doc_src/group_and_page_definitions/Makefile.am 2007-02-22 21:36:26 UTC (rev 2597)
@@ -17,4 +17,4 @@
AUTOMAKE_OPTIONS = foreign
-EXTRA_DIST = define_pages.h
+EXTRA_DIST = define_pages.h define_pages_managed.h
Added: trunk/Fdo/Docs/doc_src/group_and_page_definitions/chm_usage_notes
===================================================================
--- trunk/Fdo/Docs/doc_src/group_and_page_definitions/chm_usage_notes (rev 0)
+++ trunk/Fdo/Docs/doc_src/group_and_page_definitions/chm_usage_notes 2007-02-22 21:36:26 UTC (rev 2597)
@@ -0,0 +1,25 @@
+/*! \page page1 CHM Usage Notes
+The CHM has been created from .NET managed C++ header files using doxygen.
+\section interfaces Interface Classes
+\par
+In general an interface class name is prefixed by a capital I and does not end with 'Imp'. Those classes whose names are prefixed with a capital I and end with 'Imp' inherit from the interface class with the related name. For example, OSGeo::FDO::Commands::Locking::IAcquireLock is the name of an interface class, and OSGeo::FDO::Commands::Locking::IAcquireLockImp is the name of an implementation class which inherits from IAcquireLock.
+\par
+In the table of contents click Modules, click Interfaces and then click Classes to see the list of all of the interface classes.
+\par
+In the table of contents click Modules, click a namespace node and then click Interfaces to see the list of interfaces belonging to that namespace.
+\note
+To see the description of the interface class methods click on the inherited by link and on the page describing the implementation class scroll to the bottom.
+\section impclasses Implementation Classes
+\par
+Click on 'Class List' to see the list of implementation classes.
+\note
+You will also see the interface classes there as well.
+\section enums Enumerations
+\par
+In the table of contents click Modules, click Enums and click Enumerations to see the list of all of the enumerations.
+\par
+In the table of contents click Modules, click a namespace node and then click Enumerations to see the list of enumerations belonging to that namespace.
+\section namespaces Namespaces
+\par
+Click 'Namespace List' to see the list of namespaces and then click a namespace name to see a list of classes and interfaces contained in that namespace.
+*/
Modified: trunk/Fdo/Docs/doc_src/group_and_page_definitions/define_pages.h
===================================================================
--- trunk/Fdo/Docs/doc_src/group_and_page_definitions/define_pages.h 2007-02-22 20:53:22 UTC (rev 2596)
+++ trunk/Fdo/Docs/doc_src/group_and_page_definitions/define_pages.h 2007-02-22 21:36:26 UTC (rev 2597)
@@ -67,5 +67,4 @@
*/
/// \defgroup typedefs
/// \defgroup enums
-/// \defgroup interfaces
Added: trunk/Fdo/Docs/doc_src/group_and_page_definitions/define_pages_managed.h
===================================================================
--- trunk/Fdo/Docs/doc_src/group_and_page_definitions/define_pages_managed.h (rev 0)
+++ trunk/Fdo/Docs/doc_src/group_and_page_definitions/define_pages_managed.h 2007-02-22 21:36:26 UTC (rev 2597)
@@ -0,0 +1,91 @@
+/*! \mainpage Introduction
+<div class="mainpage">
+<!-- This is the index.htm page that the user first sees. -->
+<p>The Feature Data Objects (FDO) application
+programming interface (API) is a set of APIs used to
+manipulate, define, and analyze geospatial information.
+</p>
+<p>FDO supports the retrieving and updating of spatial and non-spatial
+GIS feature data through a rich classification model that is
+based on OpenGIS and ISO standards.
+</p>
+<p>From the perspective of a client application user: the FDO API
+provides consistent access to feature data,
+whether it comes from a CAD-based data source, or from a
+relational data store that supports rich classification. To
+achieve this, FDO supports a model that can readily follow
+the capabilities of each data source, allowing for consumer
+applications functionality that is tailored to match that of
+the data source. For example, some data sources may support
+spatial queries, while others do not. Also, a flexible
+metadata model is required in FDO, allowing clients to adapt
+to the underlying feature schema exposed by each data source.
+</p>
+<p>From the perspective of a client application engineer: the
+FDO API provides a common, general purpose abstraction layer
+for accessing geospatial data from a variety of data sources.
+The API is, in part, an interface specification of the
+abstraction layer. A provider, such as FDO Provider for SDF,
+is an implementation of the interface for a specific type of
+data source, which in this example is an implementation for
+OSGeo's spatial database format (SDF). The API can support
+the standard data store manipulation operations, such as
+querying, updating, versioning, locking, and others, only
+when the underlying data store has the same capabilities
+for these operations.
+</p>
+<h2>
+ Architecture
+</h2>
+<p>
+The high-level architecture of FDO comprises feature providers
+that plug into an application to expose a consistent feature
+schema and a consistent interface for interacting with geospatial
+feature data, regardless of the underlying data store. The
+client applications interact through the various FDO interfaces,
+such as IConnection or ICommand, using an FDO interface layer,
+or feature access manager.
+</p>
+<p>
+FDO is assembled in or consists of conceptual packages of similar
+functionality. This packaging is reflected in the substructure of
+the FDO SDK 'includes' folder. FDO commands, provider-specific
+commands, and connections/capabilities provide access to native
+data stores through each specific FDO provider. Schema management
+(using XML), client services, and filters/expressions are all
+provider-independent packages that connect directly to the FDO API.
+</p>
+<p>
+For more information, see <i>The Essential FDO</i> (FET_TheEssentialFDO.pdf)
+and the <i>FDO Developer's Guide</i> (FDG_FDODevGuide.pdf).
+</p>
+\image html FDO_architecture.png
+<br>
+</div>
+*/
+/// \defgroup OSGeoFDO OSGeo::FDO
+/// \defgroup OSGeoFDOClientServices OSGeo::FDO::ClientServices
+/// \defgroup OSGeoFDOCommands OSGeo::FDO::Commands
+/// \defgroup OSGeoFDOCommandsFeature OSGeo::FDO::Commands::Feature
+/// \defgroup OSGeoFDOCommandsDataStore OSGeo::FDO::Commands::DataStore
+/// \defgroup OSGeoFDOCommandsLocking OSGeo::FDO::Commands::Locking
+/// \defgroup OSGeoFDOCommandsLongTransaction OSGeo::FDO::Commands::LongTransaction
+/// \defgroup OSGeoFDOCommandsSchema OSGeo::FDO::Commands::Schema
+/// \defgroup OSGeoFDOCommandsSpatialContext OSGeo::FDO::Commands::SpatialContext
+/// \defgroup OSGeoFDOCommandsSQL OSGeo::FDO::Commands::SQL
+/// \defgroup OSGeoFDOCommandsUnitOfMeasure OSGeo::FDO::Commands::UnitOfMeasure
+/// \defgroup OSGeoFDOConnections OSGeo::FDO::Connections
+/// \defgroup OSGeoFDOConnectionsCapabilities OSGeo::FDO::Connections::Capabilities
+/// \defgroup OSGeoFDOExpression OSGeo::FDO::Expression
+/// \defgroup OSGeoFDOFilter OSGeo::FDO::Filter
+/// \defgroup OSGeoFDORaster OSGeo::FDO::Raster
+/// \defgroup OSGeoFDOSchema OSGeo::FDO::Schema
+/// \defgroup OSGeoFDOXml OSGeo::FDO::Xml
+/// \defgroup OSGeoFDOCommon OSGeo::FDO::Common
+/// \defgroup OSGeoFDOCommonGML212 OSGeo::FDO::Common::GML212
+/// \defgroup OSGeoFDOCommonIo OSGeo::FDO::Common::Io
+/// \defgroup OSGeoFDOCommonXml OSGeo::FDO::Common::Xml
+/// \defgroup OSGeoFDOCommonXsl OSGeo::FDO::Common::Xsl
+/// \defgroup OSGeoFDOGeometry OSGeo::FDO::Geometry
+/// \defgroup OSGeoFDORuntime OSGeo::FDO::Runtime
+/// \defgroup OSGeoFDOSpatial OSGeo::FDO::Spatial
Property changes on: trunk/Fdo/Docs/doc_src/group_and_page_definitions/define_pages_managed.h
___________________________________________________________________
Name: svn:eol-style
+ native
Modified: trunk/Fdo/Docs/doc_src/headers_and_footers/Makefile.am
===================================================================
--- trunk/Fdo/Docs/doc_src/headers_and_footers/Makefile.am 2007-02-22 20:53:22 UTC (rev 2596)
+++ trunk/Fdo/Docs/doc_src/headers_and_footers/Makefile.am 2007-02-22 21:36:26 UTC (rev 2597)
@@ -17,4 +17,5 @@
AUTOMAKE_OPTIONS = foreign
-EXTRA_DIST = custom.css footer.html header.html
+EXTRA_DIST = custom.css footer.html header.html footer_managed.html header_managed.html
+
Added: trunk/Fdo/Docs/doc_src/headers_and_footers/footer_managed.html
===================================================================
--- trunk/Fdo/Docs/doc_src/headers_and_footers/footer_managed.html (rev 0)
+++ trunk/Fdo/Docs/doc_src/headers_and_footers/footer_managed.html 2007-02-22 21:36:26 UTC (rev 2597)
@@ -0,0 +1,10 @@
+<!-- footer.html -->
+ <hr>
+ <table width="100%" border="0">
+ <tr>
+ <td>Comments or suggestions? Send us <a href="mailto:isd.docs at autodesk.com&subject=FDO%20.NET%20API%20documentation">feedback</a>.</td>
+ <!-- The logo can go in another cell, when we get one -->
+ </tr>
+ </table>
+ </body>
+</html>
\ No newline at end of file
Property changes on: trunk/Fdo/Docs/doc_src/headers_and_footers/footer_managed.html
___________________________________________________________________
Name: svn:eol-style
+ native
Added: trunk/Fdo/Docs/doc_src/headers_and_footers/header_managed.html
===================================================================
--- trunk/Fdo/Docs/doc_src/headers_and_footers/header_managed.html (rev 0)
+++ trunk/Fdo/Docs/doc_src/headers_and_footers/header_managed.html 2007-02-22 21:36:26 UTC (rev 2597)
@@ -0,0 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <title>FDO .NET API Reference</title>
+ <link href="$relpath$custom.css" rel="stylesheet" type="text/css">
+ <link href="$relpath$tabs.css" rel="stylesheet" type="text/css">
+ </head>
+ <body bgcolor="#FFFFFF">
+ <table width="100%" border="0">
+ <tr>
+ <td><b>FDO .NET API Reference<b></td>
+ <td align="right"><b>Feature Data Objects<b></td>
+ </tr>
+
+ </table>
+<!-- End of: header.html -->
\ No newline at end of file
Property changes on: trunk/Fdo/Docs/doc_src/headers_and_footers/header_managed.html
___________________________________________________________________
Name: svn:eol-style
+ native
More information about the fdo-commits
mailing list