summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJames Henstridge <james@daa.com.au>2003-03-20 10:38:40 +0000
committerPadraig O'Briain <padraigo@src.gnome.org>2003-03-20 10:38:40 +0000
commitf0877d207290ffee0f0a6f770b744cd45eab4c69 (patch)
tree1ad65e134764319fbeca85a874760d9610f30c9d /docs
parentc74d3981026bbac6575bfca6406b102e06083a70 (diff)
downloadatk-f0877d207290ffee0f0a6f770b744cd45eab4c69.tar.gz
update to call automake-1.7, libtoolize, gtkdocize and glib-gettextize.
2003-03-20 James Henstridge <james@daa.com.au> * autogen.sh: update to call automake-1.7, libtoolize, gtkdocize and glib-gettextize. * configure.in: cleanup to make use of newer autoconf/automake features. * Makefile.am: get rid of custom distcheck rule, which is no longer necessary. * atk/Makefile.am: cleanup makefile. Use BUILT_SOURCES for built sources. * docs/Makefile.am: use common gtk-doc.make. * docs/atk-docs.sgml: update to use gtk-doc's XML mode.
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am167
-rw-r--r--docs/atk-docs.sgml53
2 files changed, 43 insertions, 177 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 3310ced..93265d6 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,6 +1,6 @@
## Process this file with automake to produce Makefile.in
-EXTRA_DIST = Makefile.am atk-api.sgml atk-docs.sgml atk-sections.txt
+AUTOMAKE_OPTIONS = 1.6
# The name of the module.
DOC_MODULE=atk
@@ -11,162 +11,25 @@ DOC_MAIN_SGML_FILE=atk-docs.sgml
# The directory containing the source code (if it contains documentation).
DOC_SOURCE_DIR=../atk
+# Used for dependencies
+HFILE_GLOB = $(top_srcdir)/atk/*.h
+CFILE_GLOB = $(top_srcdir)/atk/*.c
+
# Header files to ignore when scanning
IGNORE_HFILES = atkmarshal.h atkintl.h
-# 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 $(DOC_MODULE).types is non-empty.
-GTKDOC_CFLAGS = @STRIP_BEGIN@ \
- @CFLAGS@ \
- -I$(top_srcdir) \
- -I$(top_builddir) \
- @DEP_CFLAGS@ \
-@STRIP_END@
-
-GTKDOC_LIBS = @STRIP_BEGIN@ \
- $(top_builddir)/atk/@atktargetlib@ \
-@STRIP_END@
-
-GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
-GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
-
-
-dist-hook-local: all-local
-
-####################################
-# Everything below here is generic #
-####################################
-
-# We set GPATH here; this gives us semantics for GNU make
-# which are more like other make's VPATH, when it comes to
-# whether a source that is a target of one rule is then
-# searched for in VPATH/GPATH.
-#
-GPATH = $(srcdir)
-
-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_MODULE)-overrides.txt
-
-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).signals
-
-if ENABLE_GTK_DOC
-all-local: html-build.stamp
+INCLUDES = \
+ -I$(top_srcdir) \
+ -I$(top_builddir) \
+ $(DEP_CFLAGS)
-#### scan ####
+GTKDOC_LIBS = $(top_builddir)/atk/libatk-$(ATK_API_VERSION).la
-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-scangobj --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_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_MODULE)-overrides.txt
- @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) $(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 ***'
- rm -rf $(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/*`; \
- if test "$$installfiles" = '$(srcdir)/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/* $(distdir)/html
+# gtkdoc-mkdb related varaibles
+MKDB_OPTIONS =
+content_files =
+HTML_IMAGES =
-.PHONY : dist-hook-local
+include $(top_srcdir)/gtk-doc.make
diff --git a/docs/atk-docs.sgml b/docs/atk-docs.sgml
index 3345b41..08da5e9 100644
--- a/docs/atk-docs.sgml
+++ b/docs/atk-docs.sgml
@@ -1,27 +1,29 @@
-<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
-<!entity atk-AtkAction SYSTEM "sgml/atkaction.sgml">
-<!entity atk-AtkComponent SYSTEM "sgml/atkcomponent.sgml">
-<!entity atk-AtkDocument SYSTEM "sgml/atkdocument.sgml">
-<!entity atk-AtkEditabletext SYSTEM "sgml/atkeditabletext.sgml">
-<!entity atk-AtkGObjectAccessible SYSTEM "sgml/atkgobjectaccessible.sgml">
-<!entity atk-AtkHyperlink SYSTEM "sgml/atkhyperlink.sgml">
-<!entity atk-AtkHypertext SYSTEM "sgml/atkhypertext.sgml">
-<!entity atk-AtkImage SYSTEM "sgml/atkimage.sgml">
-<!entity atk-AtkNoOpObject SYSTEM "sgml/atknoopobject.sgml">
-<!entity atk-AtkNoOpObjectFactory SYSTEM "sgml/atknoopobjectfactory.sgml">
-<!entity atk-AtkObject SYSTEM "sgml/atkobject.sgml">
-<!entity atk-AtkObjectFactory SYSTEM "sgml/atkobjectfactory.sgml">
-<!entity atk-AtkRegistry SYSTEM "sgml/atkregistry.sgml">
-<!entity atk-AtkRelation SYSTEM "sgml/atkrelation.sgml">
-<!entity atk-AtkRelationSet SYSTEM "sgml/atkrelationset.sgml">
-<!entity atk-AtkSelection SYSTEM "sgml/atkselection.sgml">
-<!entity atk-AtkState SYSTEM "sgml/atkstate.sgml">
-<!entity atk-AtkStateSet SYSTEM "sgml/atkstateset.sgml">
-<!entity atk-AtkStreamableContent SYSTEM "sgml/atkstreamablecontent.sgml">
-<!entity atk-AtkTable SYSTEM "sgml/atktable.sgml">
-<!entity atk-AtkText SYSTEM "sgml/atktext.sgml">
-<!entity atk-AtkUtil SYSTEM "sgml/atkutil.sgml">
-<!entity atk-AtkValue SYSTEM "sgml/atkvalue.sgml">
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+ <!ENTITY atk-AtkAction SYSTEM "xml/atkaction.xml">
+ <!ENTITY atk-AtkComponent SYSTEM "xml/atkcomponent.xml">
+ <!ENTITY atk-AtkDocument SYSTEM "xml/atkdocument.xml">
+ <!ENTITY atk-AtkEditabletext SYSTEM "xml/atkeditabletext.xml">
+ <!ENTITY atk-AtkGObjectAccessible SYSTEM "xml/atkgobjectaccessible.xml">
+ <!ENTITY atk-AtkHyperlink SYSTEM "xml/atkhyperlink.xml">
+ <!ENTITY atk-AtkHypertext SYSTEM "xml/atkhypertext.xml">
+ <!ENTITY atk-AtkImage SYSTEM "xml/atkimage.xml">
+ <!ENTITY atk-AtkNoOpObject SYSTEM "xml/atknoopobject.xml">
+ <!ENTITY atk-AtkNoOpObjectFactory SYSTEM "xml/atknoopobjectfactory.xml">
+ <!ENTITY atk-AtkObject SYSTEM "xml/atkobject.xml">
+ <!ENTITY atk-AtkObjectFactory SYSTEM "xml/atkobjectfactory.xml">
+ <!ENTITY atk-AtkRegistry SYSTEM "xml/atkregistry.xml">
+ <!ENTITY atk-AtkRelation SYSTEM "xml/atkrelation.xml">
+ <!ENTITY atk-AtkRelationSet SYSTEM "xml/atkrelationset.xml">
+ <!ENTITY atk-AtkSelection SYSTEM "xml/atkselection.xml">
+ <!ENTITY atk-AtkState SYSTEM "xml/atkstate.xml">
+ <!ENTITY atk-AtkStateSet SYSTEM "xml/atkstateset.xml">
+ <!ENTITY atk-AtkStreamableContent SYSTEM "xml/atkstreamablecontent.xml">
+ <!ENTITY atk-AtkTable SYSTEM "xml/atktable.xml">
+ <!ENTITY atk-AtkText SYSTEM "xml/atktext.xml">
+ <!ENTITY atk-AtkUtil SYSTEM "xml/atkutil.xml">
+ <!ENTITY atk-AtkValue SYSTEM "xml/atkvalue.xml">
]>
<book>
@@ -31,6 +33,7 @@
<chapter id="atk">
<title>ATK Library</title>
+
&atk-AtkAction;
&atk-AtkComponent;
&atk-AtkDocument;
@@ -54,6 +57,6 @@
&atk-AtkText;
&atk-AtkUtil;
&atk-AtkValue;
- </chapter>
+ </chapter>
</book>