summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSergey Udaltsov <svu@gnome.org>2006-03-12 04:20:01 +0000
committerSergey Udaltsov <svu@gnome.org>2006-03-12 04:20:01 +0000
commit2c88cc80147b72eba939d6358939ef59d403c34e (patch)
treeb6b145f6d50e1f4bba8145bef5963aee8a5f3180 /doc
parentd7bc98fb5f9d55c37a08ceeedbc87cb70ee6f133 (diff)
downloadlibxklavier-2c88cc80147b72eba939d6358939ef59d403c34e.tar.gz
branching 2.x, merging GLIBing to HEAD
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/html/.cvsignore1
-rw-r--r--doc/html/Makefile.am62
-rw-r--r--doc/reference/.cvsignore11
-rw-r--r--doc/reference/Makefile.am78
5 files changed, 90 insertions, 64 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 38d9a77..b68c774 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1 +1 @@
-SUBDIRS=html
+SUBDIRS=reference
diff --git a/doc/html/.cvsignore b/doc/html/.cvsignore
deleted file mode 100644
index 4414e3f..0000000
--- a/doc/html/.cvsignore
+++ /dev/null
@@ -1 +0,0 @@
-Makefile Makefile.in *.html *.css *.gif *.png
diff --git a/doc/html/Makefile.am b/doc/html/Makefile.am
deleted file mode 100644
index ea274a8..0000000
--- a/doc/html/Makefile.am
+++ /dev/null
@@ -1,62 +0,0 @@
-EXTRA_WEB_FILES = doxygen.css \
- doxygen.png
-
-HTML_FILES = annotated.html\
- files.html\
- functions.html\
- globals.html\
- group__activation.html\
- group__callbacks.html\
- group__currents.html\
- group__debugerr.html\
- group__enum.html\
- group__lookup.html\
- group__props.html\
- group__settings.html\
- group__wininfo.html\
- group__xkbevents.html\
- group__xkbgroup.html\
- group__xkbinfo.html\
- group__xklconfig.html\
- group__xklconfiginitterm.html\
- group__xklinitterm.html\
- index.html\
- modules.html\
- struct__XklConfigItem.html\
- struct__XklConfigItem-members.html\
- struct__XklConfigRec.html\
- struct__XklConfigRec-members.html\
- structXklState.html\
- structXklState-members.html\
- xklavier_8h.html\
- xklavier_8h-source.html\
- xklavier__config_8h.html\
- xklavier__config_8h-source.html
-
-DOXYGEN_OUT_FILES = $(EXTRA_WEB_FILES) $(HTML_FILES)
-
-doc_to = $(datadir)/doc/$(PACKAGE)-$(VERSION)/html
-
-doc_files = $(DOXYGEN_OUT_FILES)
-
-EXTRA_DIST= $(doc_files)
-
-install:
- @$(NORMAL_INSTALL)
- if test "x$(DO_DOXYGEN)" = "xyes" ; then \
- $(mkinstalldirs) $(DESTDIR)$(doc_to); \
- for p in $(doc_files); do \
- $(INSTALL_DATA) $$p $(DESTDIR)$(doc_to)/$$p; \
- done; \
- fi
-
-uninstall:
- @$(NORMAL_UNINSTALL)
- if test "x$(DO_DOXYGEN)" = "xyes" ; then \
- for p in $(doc_files); do \
- rm -f $(DESTDIR)$(doc_to)/$$p; \
- done \
- fi
-
-MAINTAINERCLEANFILES = $(DOXYGEN_OUT_FILES)
-
diff --git a/doc/reference/.cvsignore b/doc/reference/.cvsignore
new file mode 100644
index 0000000..10c9dba
--- /dev/null
+++ b/doc/reference/.cvsignore
@@ -0,0 +1,11 @@
+*.txt
+html
+sgml
+tmpl
+xml
+.libs
+*.sgml
+Makefile
+Makefile.in
+libxklavier.*
+*.stamp
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
new file mode 100644
index 0000000..532876b
--- /dev/null
+++ b/doc/reference/Makefile.am
@@ -0,0 +1,78 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# 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=libxklavier
+
+# The top-level SGML file. You can change this if you want to.
+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 the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=../../libxklavier
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=
+CFILE_GLOB=
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=xklavier_private.h xklavier_private_xkb.h xklavier_private_xmm.h xkl_engine_marshal.h
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+expand_content_files=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GLIB_CFLAGS)
+GTKDOC_LIBS=$(GLIB_LIBS) -L$(top_builddir)/libxklavier -lxklavier
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST +=