[fdo-commits] r2540 - in trunk/Providers/SHP/Docs/doc_src: .
group_and_page_definitions headers_and_footers
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Thu Feb 15 15:44:53 EST 2007
Author: gregboone
Date: 2007-02-15 15:44:53 -0500 (Thu, 15 Feb 2007)
New Revision: 2540
Added:
trunk/Providers/SHP/Docs/doc_src/Doxyfile_SHP_managed
trunk/Providers/SHP/Docs/doc_src/headers_and_footers/footer_managed.html
trunk/Providers/SHP/Docs/doc_src/headers_and_footers/header_managed.html
Modified:
trunk/Providers/SHP/Docs/doc_src/Doxyfile_SHP
trunk/Providers/SHP/Docs/doc_src/Makefile.am
trunk/Providers/SHP/Docs/doc_src/group_and_page_definitions/define_pages.h
trunk/Providers/SHP/Docs/doc_src/headers_and_footers/Makefile.am
Log:
FDO4: API - Update API documentation included in the FDO header files
Modified: trunk/Providers/SHP/Docs/doc_src/Doxyfile_SHP
===================================================================
--- trunk/Providers/SHP/Docs/doc_src/Doxyfile_SHP 2007-02-15 20:42:50 UTC (rev 2539)
+++ trunk/Providers/SHP/Docs/doc_src/Doxyfile_SHP 2007-02-15 20:44:53 UTC (rev 2540)
@@ -101,7 +101,7 @@
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 5
-IGNORE_PREFIX =
+IGNORE_PREFIX = Fdo
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
Added: trunk/Providers/SHP/Docs/doc_src/Doxyfile_SHP_managed
===================================================================
--- trunk/Providers/SHP/Docs/doc_src/Doxyfile_SHP_managed (rev 0)
+++ trunk/Providers/SHP/Docs/doc_src/Doxyfile_SHP_managed 2007-02-15 20:44:53 UTC (rev 2540)
@@ -0,0 +1,227 @@
+# Doxyfile 1.5.1-p1
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME = "FDO Provider for SHP"
+PROJECT_NUMBER =
+OUTPUT_DIRECTORY =
+CREATE_SUBDIRS = NO
+OUTPUT_LANGUAGE = English
+USE_WINDOWS_ENCODING = NO
+BRIEF_MEMBER_DESC = YES
+REPEAT_BRIEF = YES
+ABBREVIATE_BRIEF =
+ALWAYS_DETAILED_SEC = NO
+INLINE_INHERITED_MEMB = NO
+FULL_PATH_NAMES = NO
+STRIP_FROM_PATH =
+STRIP_FROM_INC_PATH =
+SHORT_NAMES = NO
+JAVADOC_AUTOBRIEF = NO
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP = YES
+INHERIT_DOCS = YES
+SEPARATE_MEMBER_PAGES = YES
+TAB_SIZE = 4
+ALIASES =
+OPTIMIZE_OUTPUT_FOR_C = NO
+OPTIMIZE_OUTPUT_JAVA = NO
+BUILTIN_STL_SUPPORT = NO
+DISTRIBUTE_GROUP_DOC = NO
+SUBGROUPING = YES
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL = YES
+EXTRACT_PRIVATE = NO
+EXTRACT_STATIC = YES
+EXTRACT_LOCAL_CLASSES = YES
+EXTRACT_LOCAL_METHODS = NO
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = NO
+HIDE_FRIEND_COMPOUNDS = NO
+HIDE_IN_BODY_DOCS = NO
+INTERNAL_DOCS = NO
+CASE_SENSE_NAMES = NO
+HIDE_SCOPE_NAMES = NO
+SHOW_INCLUDE_FILES = YES
+INLINE_INFO = YES
+SORT_MEMBER_DOCS = YES
+SORT_BRIEF_DOCS = YES
+SORT_BY_SCOPE_NAME = NO
+GENERATE_TODOLIST = NO
+GENERATE_TESTLIST = NO
+GENERATE_BUGLIST = NO
+GENERATE_DEPRECATEDLIST= NO
+ENABLED_SECTIONS =
+MAX_INITIALIZER_LINES = 30
+SHOW_USED_FILES = YES
+SHOW_DIRECTORIES = NO
+FILE_VERSION_FILTER =
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET = 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_managed.txt
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = group_and_page_definitions \
+ ../../Managed/Src/OSGeo/FDO/Providers/SHP/Override
+FILE_PATTERNS = *.h
+RECURSIVE = YES
+EXCLUDE =
+EXCLUDE_SYMLINKS = NO
+EXCLUDE_PATTERNS =
+EXAMPLE_PATH = headers_and_footers
+EXAMPLE_PATTERNS = *
+EXAMPLE_RECURSIVE = YES
+IMAGE_PATH =
+INPUT_FILTER =
+FILTER_PATTERNS =
+FILTER_SOURCE_FILES = NO
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER = YES
+INLINE_SOURCES = NO
+STRIP_CODE_COMMENTS = NO
+REFERENCED_BY_RELATION = YES
+REFERENCES_RELATION = YES
+REFERENCES_LINK_SOURCE = YES
+USE_HTAGS = NO
+VERBATIM_HEADERS = YES
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX = YES
+COLS_IN_ALPHA_INDEX = 5
+IGNORE_PREFIX = Fdo \
+ Mg
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML = YES
+HTML_OUTPUT = ../HTML/SHP_managed
+HTML_FILE_EXTENSION = .html
+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
+CHM_FILE = ../../SHP_Provider_API_managed.chm
+HHC_LOCATION = "C:/Program Files/HTML Help Workshop/hhc.exe"
+GENERATE_CHI = NO
+BINARY_TOC = YES
+TOC_EXPAND = YES
+DISABLE_INDEX = NO
+ENUM_VALUES_PER_LINE = 4
+GENERATE_TREEVIEW = YES
+TREEVIEW_WIDTH = 250
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX = NO
+LATEX_OUTPUT = latex
+LATEX_CMD_NAME = latex
+MAKEINDEX_CMD_NAME = makeindex
+COMPACT_LATEX = NO
+PAPER_TYPE = a4wide
+EXTRA_PACKAGES =
+LATEX_HEADER =
+PDF_HYPERLINKS = NO
+USE_PDFLATEX = NO
+LATEX_BATCHMODE = NO
+LATEX_HIDE_INDICES = NO
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF = NO
+RTF_OUTPUT = rtf
+COMPACT_RTF = NO
+RTF_HYPERLINKS = NO
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN = NO
+MAN_OUTPUT = man
+MAN_EXTENSION = .3
+MAN_LINKS = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML = NO
+XML_OUTPUT = xml
+XML_SCHEMA =
+XML_DTD =
+XML_PROGRAMLISTING = YES
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD = NO
+PERLMOD_LATEX = NO
+PERLMOD_PRETTY = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = YES
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH =
+INCLUDE_FILE_PATTERNS =
+PREDEFINED =
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES =
+GENERATE_TAGFILE =
+ALLEXTERNALS = NO
+EXTERNAL_GROUPS = YES
+PERL_PATH = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS = NO
+HIDE_UNDOC_RELATIONS = YES
+HAVE_DOT = YES
+CLASS_GRAPH = YES
+COLLABORATION_GRAPH = NO
+GROUP_GRAPHS = NO
+UML_LOOK = YES
+TEMPLATE_RELATIONS = NO
+INCLUDE_GRAPH = YES
+INCLUDED_BY_GRAPH = YES
+CALL_GRAPH = YES
+CALLER_GRAPH = NO
+GRAPHICAL_HIERARCHY = YES
+DIRECTORY_GRAPH = YES
+DOT_IMAGE_FORMAT = png
+DOT_PATH =
+DOTFILE_DIRS =
+MAX_DOT_GRAPH_WIDTH = 1024
+MAX_DOT_GRAPH_HEIGHT = 1024
+MAX_DOT_GRAPH_DEPTH = 1000
+DOT_TRANSPARENT = NO
+DOT_MULTI_TARGETS = NO
+GENERATE_LEGEND = YES
+DOT_CLEANUP = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine
+#---------------------------------------------------------------------------
+SEARCHENGINE = NO
Property changes on: trunk/Providers/SHP/Docs/doc_src/Doxyfile_SHP_managed
___________________________________________________________________
Name: svn:eol-style
+ native
Modified: trunk/Providers/SHP/Docs/doc_src/Makefile.am
===================================================================
--- trunk/Providers/SHP/Docs/doc_src/Makefile.am 2007-02-15 20:42:50 UTC (rev 2539)
+++ trunk/Providers/SHP/Docs/doc_src/Makefile.am 2007-02-15 20:44:53 UTC (rev 2540)
@@ -21,4 +21,4 @@
DIST_SUBDIRS = group_and_page_definitions headers_and_footers
-EXTRA_DIST = Doxyfile_SHP
+EXTRA_DIST = Doxyfile_SHP Doxyfile_SHP_managed
Modified: trunk/Providers/SHP/Docs/doc_src/group_and_page_definitions/define_pages.h
===================================================================
--- trunk/Providers/SHP/Docs/doc_src/group_and_page_definitions/define_pages.h 2007-02-15 20:42:50 UTC (rev 2539)
+++ trunk/Providers/SHP/Docs/doc_src/group_and_page_definitions/define_pages.h 2007-02-15 20:44:53 UTC (rev 2540)
@@ -7,31 +7,38 @@
that provides access to data in a particular data store. The FDO
Provider for SHP provides FDO with access to a SHP-based data store.
</p>
-<p>The FDO Provider for SHP uses a standalone file format that
-supports GIS data. The FDO Provider for SHP (Shape) has the
-following characteristics:
+
+<p>The standalone ESRI SHP file format supports GIS data using a number of
+separate files: SHP (shape geometry), SHX (shape index), PRJ (projection
+information), CPG (code page files), IDX (spatial index), and DBF (shape
+attributes in dBASE format). You must have either a SHP or DBF file present to
+connect to data or work with schemas. Otherwise, these files are optional. Files
+with empty records are created, if they do not exist initially.
</p>
+
+<p>In AutoCAD Map 3D 2008, the Schema Editor treats each SHP file, and its
+associated DBF file, as a feature class with a single geometry property and,
+optionally, data attribute properties. The SHP file format supports a single
+writer at any time, with multiple readers.
+</p>
+
+<p>SHP files can include only one geometry type per file, but you can stored and
+copy to multiple SHP files in a folder. You can use a configuration file to
+support multiple schemas when you establish your connection to a folder
+containing SHP files.
+</p>
+
+<p>A SHP schema can support the following:
+</p>
<ul>
- <li> Read-only access is provided to pre-existing
- spatial and attribute data from an Environmental Systems
- Research Institute (ESRI) Shape file (SHP).
- <li> The FDO Provider for SHP can run in a multi-platform environment,
- including Windows and Linux.
- <li> A Shape file consists of three separate files: SHP (shape
- geometry), SHX (shape index), and DBF (shape attributes in
- dBASE format).
- <li> The FDO Provider for SHP accesses the information in each of the
- three separate files, and treats each SHP, and its associated DBF file,
- as a feature class with a single geometry property, and optionally,
- with data attribute properties.
- <li> Schema configuration of the data store is provided to the
- FDO Provider for SHP through an XML file containing the
- Geographic Markup Language (GML) definition of the schema
- that maps SHP and DBF data in the data store to feature
- classes and property mappings in the FDO data model.
- <li> Although it does not support concurrency control (locking), the SHP
- file format is a valid alternative to RDBMS.
+ <li>A single geometry type per file
+ <li>Spatial contexts (determined by coordinate system information in the PRJ file)
+ <li>Auto ID generation
+ <li>Null value constraints
+ <li>These geometry types: point, line string, polygon, multi-point, multi-line
+ string, multi-polygon, linear ring, and line string segment.
</ul>
+
<p>
For more information, see <i>The Essential FDO</i> (FET_TheEssentialFDO.pdf)
and the <i>FDO Developer's Guide</i> (FDG_FDODevGuide.pdf).
Modified: trunk/Providers/SHP/Docs/doc_src/headers_and_footers/Makefile.am
===================================================================
--- trunk/Providers/SHP/Docs/doc_src/headers_and_footers/Makefile.am 2007-02-15 20:42:50 UTC (rev 2539)
+++ trunk/Providers/SHP/Docs/doc_src/headers_and_footers/Makefile.am 2007-02-15 20:44:53 UTC (rev 2540)
@@ -17,4 +17,4 @@
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/Providers/SHP/Docs/doc_src/headers_and_footers/footer_managed.html
===================================================================
--- trunk/Providers/SHP/Docs/doc_src/headers_and_footers/footer_managed.html (rev 0)
+++ trunk/Providers/SHP/Docs/doc_src/headers_and_footers/footer_managed.html 2007-02-15 20:44:53 UTC (rev 2540)
@@ -0,0 +1,10 @@
+<!-- footer.html -->
+ <hr>
+ <table width="100%" border="0">
+ <tr>
+ <td align="right"><font size="-2"><a href="mailto:isd.docs at autodesk.com&subject=FDO%20Provider%20for%20SHP%20.NET%20API%20documentation">Comments?</a></font></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/Providers/SHP/Docs/doc_src/headers_and_footers/footer_managed.html
___________________________________________________________________
Name: svn:eol-style
+ native
Added: trunk/Providers/SHP/Docs/doc_src/headers_and_footers/header_managed.html
===================================================================
--- trunk/Providers/SHP/Docs/doc_src/headers_and_footers/header_managed.html (rev 0)
+++ trunk/Providers/SHP/Docs/doc_src/headers_and_footers/header_managed.html 2007-02-15 20:44:53 UTC (rev 2540)
@@ -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>OSGeo FDO Provider for SHP .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>.NET API Reference<b></td>
+ <td align="right"><b>OSGeo FDO Provider for SHP<b></td>
+ </tr>
+
+ </table>
+<!-- End of: header.html -->
\ No newline at end of file
Property changes on: trunk/Providers/SHP/Docs/doc_src/headers_and_footers/header_managed.html
___________________________________________________________________
Name: svn:eol-style
+ native
More information about the fdo-commits
mailing list