26e7962dfe
Meson's gtk-doc support currently requires the main SGML/XML file to be located in the srcdir, so instead of substituting the module version in that file directly, use a small auxiliary file that's included via a custom entity. https://bugzilla.gnome.org/show_bug.cgi?id=783229
140 lines
4.7 KiB
Makefile
140 lines
4.7 KiB
Makefile
## 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=shell
|
|
|
|
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
|
|
#DOC_MODULE_VERSION=2
|
|
|
|
|
|
# The top-level SGML file. You can change this if you want to.
|
|
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
|
|
|
|
# Directories containing the source code
|
|
# gtk-doc will search all .c and .h files beneath these paths
|
|
# for inline comments documenting functions and macros.
|
|
DOC_SOURCE_DIR=$(top_srcdir)/src
|
|
|
|
# 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=--rebuild-types
|
|
|
|
# Extra options to supply to gtkdoc-mkdb.
|
|
# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
|
|
MKDB_OPTIONS=--xml-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-mkhtml
|
|
MKHTML_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=$(top_srcdir)/src/*.h
|
|
CFILE_GLOB=$(top_srcdir)/src/*.c
|
|
|
|
# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
|
|
# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
|
|
EXTRA_HFILES=
|
|
|
|
# Header files or dirs to ignore when scanning. Use base file/dir names
|
|
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
|
|
IGNORE_HFILES= \
|
|
calendar-server \
|
|
gvc \
|
|
hotplug-sniffer \
|
|
st \
|
|
tray \
|
|
gactionmuxer.h \
|
|
gactionobservable.h \
|
|
gactionobserver.h \
|
|
shell-network-agent.h \
|
|
shell-recorder-src.h
|
|
|
|
if !BUILD_RECORDER
|
|
IGNORE_HFILES += shell-recorder.h
|
|
endif
|
|
|
|
# Images to copy into HTML directory.
|
|
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
|
|
HTML_IMAGES=
|
|
|
|
doc-gen-org.gnome.Shell.SearchProvider.xml: $(top_srcdir)/data/org.gnome.ShellSearchProvider.xml
|
|
gdbus-codegen \
|
|
--interface-prefix org.gnome.ShellSearchProvider. \
|
|
--generate-docbook doc-gen \
|
|
$(top_srcdir)/data/org.gnome.ShellSearchProvider.xml
|
|
|
|
doc-gen-org.gnome.Shell.SearchProvider2.xml: $(top_srcdir)/data/org.gnome.ShellSearchProvider2.xml
|
|
gdbus-codegen \
|
|
--interface-prefix org.gnome.ShellSearchProvider2. \
|
|
--generate-docbook doc-gen \
|
|
$(top_srcdir)/data/org.gnome.ShellSearchProvider2.xml
|
|
|
|
doc-gen-org.gnome.Shell.Screenshot.xml: $(top_srcdir)/data/org.gnome.Shell.Screenshot.xml
|
|
gdbus-codegen \
|
|
--interface-prefix org.gnome.Shell.Screenshot. \
|
|
--generate-docbook doc-gen \
|
|
$(top_srcdir)/data/org.gnome.Shell.Screenshot.xml
|
|
|
|
# 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= \
|
|
doc-gen-org.gnome.Shell.SearchProvider.xml \
|
|
doc-gen-org.gnome.Shell.SearchProvider2.xml \
|
|
doc-gen-org.gnome.Shell.Screenshot.xml
|
|
|
|
# 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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
|
|
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
|
|
GTKDOC_CFLAGS=$(GNOME_SHELL_CFLAGS)
|
|
GTKDOC_LIBS=$(GNOME_SHELL_LIBS) $(top_builddir)/src/libgnome-shell-menu.la $(top_builddir)/src/libgnome-shell.la -rpath $(MUTTER_TYPELIB_DIR)
|
|
|
|
# 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 += version.xml.in
|
|
|
|
# Files not to distribute
|
|
# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
|
|
# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
|
|
DISTCLEANFILES = $(DOC_MODULE).types
|
|
|
|
# Comment this out if you want 'make check' to test you doc status
|
|
# and run some sanity checks
|
|
if ENABLE_GTK_DOC
|
|
TESTS_ENVIRONMENT = cd $(srcdir) && \
|
|
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
|
|
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
|
|
#TESTS = $(GTKDOC_CHECK)
|
|
endif
|
|
|
|
-include $(top_srcdir)/git.mk
|