mirror of
https://gitlab.gnome.org/GNOME/gtk.git
synced 2024-12-26 13:41:07 +00:00
32abeb4c96
Sun Feb 11 22:16:34 2001 Owen Taylor <otaylor@redhat.com> * */Makefile.am: Use the new snazzy mother-of-all-gtk-doc-makefiles. * gdk/tmpl/* gdk-pixbuf/tmpl/*: Recover a bunch of docs that were lost at one point.
180 lines
4.8 KiB
Makefile
180 lines
4.8 KiB
Makefile
## Process this file with automake to produce Makefile.in
|
|
|
|
# The name of the module.
|
|
DOC_MODULE=gdk
|
|
|
|
# The top-level SGML file.
|
|
DOC_MAIN_SGML_FILE=gdk-docs.sgml
|
|
|
|
# The directory containing the source code (if it contains documentation).
|
|
DOC_SOURCE_DIR=$(top_srcdir)/gdk
|
|
|
|
# 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=--extra-dir=../gdk-pixbuf/html
|
|
|
|
# Used for dependencies
|
|
HFILE_GLOB=$(top_srcdir)/gdk/*.h $(top_srcdir)/gdk/x11/gdkx.h
|
|
CFILE_GLOB=$(top_srcdir)/gdk/*.c
|
|
|
|
# Header files to ignore when scanning
|
|
IGNORE_HFILES= \
|
|
gdkkeysyms.h \
|
|
gdkinternals.h \
|
|
gdkprivate.h \
|
|
gdkpoly-generic.h \
|
|
gdkregion-generic.h \
|
|
linux-fb \
|
|
nanox \
|
|
win32 \
|
|
x11
|
|
|
|
# Extra files to add when scanning
|
|
EXTRA_HFILES= \
|
|
$(top_srcdir)/gdk/x11/gdkx.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 =
|
|
GTKDOC_LIBS =
|
|
|
|
# Commands for compiling and linking
|
|
GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
|
|
GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
|
|
|
|
|
|
####################################
|
|
# Everything below here is generic #
|
|
####################################
|
|
|
|
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
|
|
|
|
if ENABLE_GTK_DOC
|
|
all-local: html-build.stamp
|
|
|
|
SCANOBJ_FILES = \
|
|
$(DOC_MODULE).args \
|
|
$(DOC_MODULE).hierarchy \
|
|
$(DOC_MODULE).signal
|
|
|
|
scan-build.stamp: $(HFILE_GLOB)
|
|
@echo '*** Scanning header files ***'
|
|
cd $(srcdir) && ( \
|
|
if grep -l '^.+$$' $(DOC_MODULE).types > /dev/null ; then \
|
|
CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) ; \
|
|
else \
|
|
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
|
|
|
|
check_scan:
|
|
$(MAKE) scan-build.stamp
|
|
|
|
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): check_scan
|
|
|
|
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
|
|
|
|
check_templates:
|
|
$(MAKE) tmpl-build.stamp
|
|
|
|
tmpl.stamp: check_templates
|
|
|
|
sgml-build.stamp: tmpl.stamp $(CFILE_GLOB)
|
|
@echo '*** Building SGML ***'
|
|
cd $(srcdir) && \
|
|
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
|
|
touch sgml-build.stamp
|
|
|
|
check_sgml:
|
|
$(MAKE) sgml-build.stamp
|
|
|
|
sgml.stamp: check_sgml
|
|
|
|
html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE)
|
|
@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) $(srcdir)/sgml.stamp
|
|
|
|
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)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
|
|
-cp $(srcdir)/html/index.sgml $(distdir)/html
|
|
-cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
|
|
for i in $(HTML_IMAGES) ; do \
|
|
cp $(srcdir)/$$i $(distdir)/html ; \
|
|
done
|
|
|
|
.PHONY : check_sgml check_templates check_scan dist-hook-local
|