From 2cd87ed00ff4bfe20abcec50043692f0c615a3fa Mon Sep 17 00:00:00 2001 From: Brian Cameron Date: Thu, 31 May 2001 15:01:15 +0000 Subject: [PATCH] Updated docs/Makefile.am so that make install works. --- docs/Makefile.am | 118 +++++++++++++++++++++++++++++++++++++++------- docs/tmpl/atk-unused.sgml | 20 ++++++++ docs/tmpl/atkobject.sgml | 2 +- 3 files changed, 123 insertions(+), 17 deletions(-) diff --git a/docs/Makefile.am b/docs/Makefile.am index eb9f7cc..71d4aa8 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -11,33 +11,119 @@ DOC_MAIN_SGML_FILE=atk-docs.sgml # The directory containing the source code (if it contains documentation). DOC_SOURCE_DIR=../atk +INSTALLDIR=$(prefix)/share/gtk-doc + +HTML_DIR = ${datadir}/gtk-doc/html + +TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) + +# 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 = + +#################################### +# Everything below here is generic # +#################################### TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) -scan: - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="libgnomeP.h gnome-i18nP.h gnome-triggersP.h gnome-magic.h vroot.h" +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 -templates: scan - gtkdoc-mktmpl --module=$(DOC_MODULE) +SCANOBJ_FILES = \ + $(DOC_MODULE).args \ + $(DOC_MODULE).hierarchy \ + $(DOC_MODULE).signals -sgml: - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) +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-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 ***' + 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 -html: - if test ! -d html ; then mkdir html ; fi - -cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) +############## clean-local: - rm -f *~ *.bak *.hierarchy *.signals *.args *-unused.txt + rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) -maintainer-clean-local: clean-local - rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt +maintainer-clean-local: clean + cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt install-data-local: - install -d -m 0755 $(TARGET_DIR) - install -m 0644 html/*.html $(TARGET_DIR) - install -m 0644 html/index.sgml $(TARGET_DIR) - gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR) + $(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 diff --git a/docs/tmpl/atk-unused.sgml b/docs/tmpl/atk-unused.sgml index e69de29..d81c262 100644 --- a/docs/tmpl/atk-unused.sgml +++ b/docs/tmpl/atk-unused.sgml @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + +atk + + diff --git a/docs/tmpl/atkobject.sgml b/docs/tmpl/atkobject.sgml index 3dde031..841251a 100644 --- a/docs/tmpl/atkobject.sgml +++ b/docs/tmpl/atkobject.sgml @@ -77,7 +77,7 @@ of the following interfaces: @ATK_ROLE_SLIDER: @ATK_ROLE_SPLIT_PANE: @ATK_ROLE_SPIN_BUTTON: -@ATK_ROLE_STATUS_BAR: +@ATK_ROLE_STATUSBAR: @ATK_ROLE_TABLE: @ATK_ROLE_TABLE_CELL: @ATK_ROLE_TABLE_COLUMN_HEADER: -- 2.7.4