mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-09-21 01:36:15 +02:00
5e45a337b8
* glib/gmain.c: Remove references to nonexisting functions g_source_set_callback_closure(), g_source_poll(), g_source_add() from docs. * glib/gdir.c (g_dir_open): Typo fix in docs. * glib/gasyncqueue.c (g_async_queue_lock): (g_async_queue_unref_and_unlock): Fix markup to avoid erroneous <link>s in docs. * glib/gwin32.c: Escape #'s leading to erroneous <link>s in docs. * glib/gtree.c: Replace some occurances of Gtree by GTree in docs. * glib/gstring.c (g_string_insert_unichar): Typo fix in docs. * glib/tmpl/conversions.sgml: Add GIConv. * glib/tmpl/main.sgml: Fix references to nonexisting functions g_main_loop_destroy(), g_source_add(), g_source_connect(). * glib/glib-sections.txt: Add GIConv, g_str_has_prefix, g_str_has_suffix. * glib/tmpl/linked_lists_single.sgml: * glib/tmpl/linked_lists_double.sgml: GListAllocator doesn't exist. * glib/glib-docs.sgml: Declare hash entity. * glib/tmpl/macros.sgml: Escape # in #ifdef to suppress erroneous links. * gobject/Makefile.am, gobject/gobject-docs.sgml, gobject/tmpl/*: * glib/Makefile.am, glib/glib-docs.sgml, glib/tmpl/*: Produce XML, not SGML.
178 lines
4.7 KiB
Makefile
178 lines
4.7 KiB
Makefile
## Process this file with automake to produce Makefile.in
|
|
|
|
# The name of the module.
|
|
DOC_MODULE=gobject
|
|
|
|
# The top-level SGML file.
|
|
DOC_MAIN_SGML_FILE=gobject-docs.sgml
|
|
|
|
# The directory containing the source code. Relative to $(srcdir)
|
|
DOC_SOURCE_DIR=../../../gobject
|
|
|
|
# Extra options to supply to gtkdoc-scan
|
|
SCAN_OPTIONS=
|
|
|
|
# Extra options to supply to gtkdoc-mkdb
|
|
MKDB_OPTIONS=--output-format=xml
|
|
|
|
# Extra options to supply to gtkdoc-fixref
|
|
FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../glib/html
|
|
|
|
# Used for dependencies
|
|
HFILE_GLOB=$(top_srcdir)/gobject/*.h
|
|
CFILE_GLOB=$(top_srcdir)/gobject/*.c
|
|
|
|
# Headers to ignore
|
|
IGNORE_HFILES=
|
|
|
|
# Extra files to add when scanning
|
|
EXTRA_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 $(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 #
|
|
####################################
|
|
|
|
# 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
|
|
|
|
#### 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 ***'
|
|
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
|
|
|
|
.PHONY : dist-hook-local
|