mirror of
https://github.com/mdbtools/mdbtools.git
synced 2025-09-18 18:22:07 +08:00
first cut at gtk-doc
This commit is contained in:
brianb
@@ -49,6 +49,7 @@ MDB Tools includes
|
||||
<li> MDBSQL, a SQL engine layered on top of LibMDB.</li>
|
||||
<li> MDB ODBC driver, a ODBC driver - requires unixODBC driver manager.</li>
|
||||
<li> gmdb2, a graphical interface including SQL query tool and file debugger.</li>
|
||||
</ul>
|
||||
</dd></dl>
|
||||
|
||||
<dl><a name="license"></a><dt><b>1.4 What license is MDB Tools under</b></dt><dd>
|
||||
|
||||
190
doc/reference/libmdb/Makefile.am
Normal file
190
doc/reference/libmdb/Makefile.am
Normal file
@@ -0,0 +1,190 @@
|
||||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
# This is a blank Makefile.am for using gtk-doc.
|
||||
# Copy this to your project's API docs directory and modify the variables to
|
||||
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
|
||||
# of using the various options.
|
||||
|
||||
# The name of the module, e.g. 'glib'.
|
||||
DOC_MODULE=libmdb
|
||||
|
||||
# The top-level SGML file. Change it if you want.
|
||||
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
|
||||
|
||||
# The directory containing the source code. Relative to $(srcdir).
|
||||
# gtk-doc will search all .c & .h files beneath here for inline comments
|
||||
# documenting functions and macros.
|
||||
DOC_SOURCE_DIR=$(top_srcdir)/src/libmdb
|
||||
DOC_HEADER_DIR=$(top_srcdir)/include
|
||||
|
||||
# Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj.
|
||||
SCANOBJ_OPTIONS=
|
||||
|
||||
# Extra options to supply to gtkdoc-scan.
|
||||
SCAN_OPTIONS=
|
||||
|
||||
# Extra options to supply to gtkdoc-mkdb.
|
||||
MKDB_OPTIONS=
|
||||
|
||||
# Extra options to supply to gtkdoc-fixref.
|
||||
FIXXREF_OPTIONS=
|
||||
|
||||
# Used for dependencies.
|
||||
HFILE_GLOB=
|
||||
CFILE_GLOB=
|
||||
|
||||
# Header files to ignore when scanning.
|
||||
IGNORE_HFILES=
|
||||
|
||||
# Images to copy into HTML directory.
|
||||
HTML_IMAGES =
|
||||
|
||||
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
||||
content_files =
|
||||
|
||||
# Other files to distribute.
|
||||
extra_files =
|
||||
|
||||
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
|
||||
# contains GtkObjects/GObjects and you want to document signals and properties.
|
||||
GTKDOC_CFLAGS =
|
||||
GTKDOC_LIBS =
|
||||
|
||||
GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
|
||||
GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
|
||||
|
||||
# If you need to override some of the declarations, place them in the
|
||||
# $(DOC_MODULE)-overrides.txt file and uncomment the second line here.
|
||||
DOC_OVERRIDES =
|
||||
#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
|
||||
|
||||
|
||||
|
||||
###########################################################################
|
||||
# Everything below here is generic and you shouldn't need to change it.
|
||||
###########################################################################
|
||||
|
||||
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
|
||||
|
||||
EXTRA_DIST = \
|
||||
$(content_files) \
|
||||
$(extra_files) \
|
||||
$(HTML_IMAGES) \
|
||||
$(DOC_MAIN_SGML_FILE) \
|
||||
$(DOC_MODULE).types \
|
||||
$(DOC_MODULE)-sections.txt \
|
||||
$(DOC_OVERRIDES)
|
||||
|
||||
DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
|
||||
$(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
|
||||
|
||||
SCANOBJ_FILES = \
|
||||
$(DOC_MODULE).args \
|
||||
$(DOC_MODULE).hierarchy \
|
||||
$(DOC_MODULE).interfaces \
|
||||
$(DOC_MODULE).prerequisites \
|
||||
$(DOC_MODULE).signals
|
||||
|
||||
if ENABLE_GTK_DOC
|
||||
all-local: html-build.stamp
|
||||
|
||||
#### scan ####
|
||||
|
||||
scan-build.stamp: $(HFILE_GLOB)
|
||||
@echo '*** Scanning header files ***'
|
||||
if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
|
||||
CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scanobj $(SCANOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
|
||||
else \
|
||||
cd $(srcdir) ; \
|
||||
for i in $(SCANOBJ_FILES) ; do \
|
||||
test -f $$i || touch $$i ; \
|
||||
done \
|
||||
fi
|
||||
cd $(srcdir) && \
|
||||
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_HEADER_DIR) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
|
||||
touch scan-build.stamp
|
||||
|
||||
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
|
||||
@true
|
||||
|
||||
#### templates ####
|
||||
|
||||
tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
|
||||
@echo '*** Rebuilding template files ***'
|
||||
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
|
||||
touch tmpl-build.stamp
|
||||
|
||||
tmpl.stamp: tmpl-build.stamp
|
||||
@true
|
||||
|
||||
#### sgml ####
|
||||
|
||||
sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
|
||||
@echo '*** Building SGML ***'
|
||||
cd $(srcdir) && \
|
||||
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS)
|
||||
touch sgml-build.stamp
|
||||
|
||||
sgml.stamp: sgml-build.stamp
|
||||
@true
|
||||
|
||||
#### html ####
|
||||
|
||||
html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
|
||||
@echo '*** Building HTML ***'
|
||||
test -d $(srcdir)/html || mkdir $(srcdir)/html
|
||||
cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
|
||||
test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
|
||||
@echo '-- Fixing Crossreferences'
|
||||
cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
|
||||
touch html-build.stamp
|
||||
endif
|
||||
|
||||
##############
|
||||
|
||||
clean-local:
|
||||
rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
|
||||
|
||||
maintainer-clean-local: clean
|
||||
cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
|
||||
|
||||
install-data-local:
|
||||
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
|
||||
(installfiles=`echo $(srcdir)/html/*.html`; \
|
||||
if test "$$installfiles" = '$(srcdir)/html/*.html'; \
|
||||
then echo '-- Nothing to install' ; \
|
||||
else \
|
||||
for i in $$installfiles; do \
|
||||
echo '-- Installing '$$i ; \
|
||||
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
|
||||
done; \
|
||||
echo '-- Installing $(srcdir)/html/index.sgml' ; \
|
||||
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
|
||||
fi)
|
||||
|
||||
#
|
||||
# Require gtk-doc when making dist
|
||||
#
|
||||
if ENABLE_GTK_DOC
|
||||
dist-check-gtkdoc:
|
||||
else
|
||||
dist-check-gtkdoc:
|
||||
@echo "*** gtk-doc must be installed and enabled in order to make dist"
|
||||
@false
|
||||
endif
|
||||
|
||||
dist-hook: dist-check-gtkdoc dist-hook-local
|
||||
mkdir $(distdir)/tmpl
|
||||
mkdir $(distdir)/sgml
|
||||
mkdir $(distdir)/html
|
||||
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
|
||||
-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
|
||||
-cp $(srcdir)/html/index.sgml $(distdir)/html
|
||||
-cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
|
||||
|
||||
images=$(HTML_IMAGES) ; \
|
||||
for i in $$images ; do \
|
||||
cp $(srcdir)/$$i $(distdir)/html ; \
|
||||
done
|
||||
|
||||
.PHONY : dist-hook-local
|
||||
13
doc/reference/libmdb/libmdb-docs.sgml
Normal file
13
doc/reference/libmdb/libmdb-docs.sgml
Normal file
@@ -0,0 +1,13 @@
|
||||
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
|
||||
<!ENTITY libmdb-mdbtools SYSTEM "sgml/mdbtools.sgml">
|
||||
]>
|
||||
<book id="index">
|
||||
<bookinfo>
|
||||
<title>LibMDB Reference Manual</title>
|
||||
</bookinfo>
|
||||
|
||||
<chapter>
|
||||
<title>LibMDB Function List</title>
|
||||
&libmdb-mdbtools;
|
||||
</chapter>
|
||||
</book>
|
||||
144
doc/reference/libmdb/libmdb-sections.txt
Normal file
144
doc/reference/libmdb/libmdb-sections.txt
Normal file
@@ -0,0 +1,144 @@
|
||||
<SECTION>
|
||||
<FILE>mdbtools</FILE>
|
||||
MDB_DEBUG
|
||||
MDB_PGSIZE
|
||||
MDB_MAX_OBJ_NAME
|
||||
MDB_MAX_COLS
|
||||
MDB_MAX_IDX_COLS
|
||||
MDB_CATALOG_PG
|
||||
MDB_MEMO_OVERHEAD
|
||||
MDB_BIND_SIZE
|
||||
MdbStrategy
|
||||
mdb_is_logical_op
|
||||
mdb_is_relational_op
|
||||
IS_JET4
|
||||
IS_JET3
|
||||
mdb_backends
|
||||
MdbBackendType
|
||||
MdbBackend
|
||||
MdbStatistics
|
||||
MdbFile
|
||||
MdbFormatConstants
|
||||
MdbHandle
|
||||
MdbCatalogEntry
|
||||
MdbProperties
|
||||
MdbColumn
|
||||
mdbsargtree
|
||||
MdbIndexPage
|
||||
gpointer)
|
||||
MDB_MAX_INDEX_DEPTH
|
||||
MdbIndexChain
|
||||
MdbTableDef
|
||||
MdbColumnProp
|
||||
MdbField
|
||||
MdbSarg
|
||||
mdb_init
|
||||
mdb_exit
|
||||
mdb_alloc_handle
|
||||
mdb_free_handle
|
||||
mdb_free_catalog
|
||||
mdb_alloc_tabledef
|
||||
mdb_alloc_catalog
|
||||
mdb_alloc_file
|
||||
mdb_free_file
|
||||
mdb_append_index
|
||||
mdb_alloc_stats
|
||||
mdb_read_pg
|
||||
mdb_read_alt_pg
|
||||
mdb_get_byte
|
||||
mdb_get_int16
|
||||
mdb_get_int24
|
||||
mdb_get_int32
|
||||
mdb_get_single
|
||||
mdb_get_double
|
||||
mdb_pg_get_byte
|
||||
mdb_pg_get_int16
|
||||
mdb_pg_get_int24
|
||||
mdb_pg_get_int32
|
||||
mdb_pg_get_single
|
||||
mdb_pg_get_double
|
||||
mdb_pg_get_int24_msb
|
||||
mdb_open
|
||||
mdb_close
|
||||
mdb_clone_handle
|
||||
mdb_swap_pgbuf
|
||||
mdb_free_tabledef
|
||||
mdb_read_catalog
|
||||
mdb_catalog_dump
|
||||
mdb_catalog_rows
|
||||
mdb_get_catalog_entry
|
||||
mdb_get_objtype_string
|
||||
mdb_dump_catalog
|
||||
mdb_read_table
|
||||
mdb_read_columns
|
||||
mdb_table_dump
|
||||
read_pg_if_16
|
||||
read_pg_if_32
|
||||
read_pg_if
|
||||
read_pg_if_n
|
||||
mdb_bind_column_by_name
|
||||
mdb_data_dump
|
||||
mdb_bind_column
|
||||
mdb_rewind_table
|
||||
mdb_fetch_row
|
||||
mdb_is_fixed_col
|
||||
mdb_col_to_string
|
||||
mdb_find_end_of_row
|
||||
mdb_col_fixed_size
|
||||
mdb_col_disp_size
|
||||
mdb_bind_len
|
||||
mdb_ole_read_next
|
||||
mdb_ole_read
|
||||
mdb_set_date_fmt
|
||||
mdb_read_row
|
||||
buffer_dump
|
||||
mdb_get_coltype_string
|
||||
mdb_coltype_takes_length
|
||||
mdb_init_backends
|
||||
mdb_register_backend
|
||||
mdb_remove_backends
|
||||
mdb_set_default_backend
|
||||
mdb_get_relationships
|
||||
mdb_test_sargs
|
||||
mdb_test_sarg
|
||||
mdb_sql_walk_tree
|
||||
mdb_find_indexable_sargs
|
||||
mdb_add_sarg_by_name
|
||||
mdb_test_string
|
||||
mdb_test_int
|
||||
mdb_add_sarg
|
||||
mdb_read_indices
|
||||
mdb_index_dump
|
||||
mdb_index_scan_free
|
||||
mdb_index_find_next_on_page
|
||||
mdb_index_find_next
|
||||
mdb_index_hash_text
|
||||
mdb_index_scan_init
|
||||
mdb_index_find_row
|
||||
mdb_index_swap_n
|
||||
mdb_stats_on
|
||||
mdb_stats_off
|
||||
mdb_dump_stats
|
||||
mdb_like_cmp
|
||||
mdb_crack_row
|
||||
mdb_add_row_to_pg
|
||||
mdb_update_index
|
||||
mdb_pack_row
|
||||
mdb_replace_row
|
||||
mdb_pg_get_freespace
|
||||
mdb_update_row
|
||||
mdb_new_data_pg
|
||||
mdb_map_find_next_freepage
|
||||
mdb_read_props_list
|
||||
mdb_free_props
|
||||
mdb_read_props
|
||||
mdb_create_temp_table
|
||||
mdb_temp_table_add_col
|
||||
mdb_fill_temp_col
|
||||
mdb_fill_temp_field
|
||||
mdb_get_option
|
||||
mdb_debug
|
||||
mdb_unicode2ascii
|
||||
mdb_ascii2unicode
|
||||
</SECTION>
|
||||
|
||||
Reference in New Issue
Block a user