|
Packit |
aea12f |
# This is a blank Makefile.am for using gtk-doc.
|
|
Packit |
aea12f |
# Copy this to your project's API docs directory and modify the variables to
|
|
Packit |
aea12f |
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
|
|
Packit |
aea12f |
# of using the various options.
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# The name of the module, e.g. 'glib'.
|
|
Packit |
aea12f |
DOC_MODULE=$(PACKAGE)
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
|
|
Packit |
aea12f |
#DOC_MODULE_VERSION=2
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# The top-level XML file.
|
|
Packit |
aea12f |
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Directories containing the source code.
|
|
Packit |
aea12f |
# gtk-doc will search all .c and .h files beneath these paths
|
|
Packit |
aea12f |
# for inline comments documenting functions and macros.
|
|
Packit |
aea12f |
# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
|
|
Packit |
aea12f |
DOC_SOURCE_DIR=$(top_srcdir)/lib $(top_srcdir)/libdane/ $(top_builddir)/lib/includes/
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Extra options to pass to gtkdoc-scangobj. Normally not needed.
|
|
Packit |
aea12f |
SCANGOBJ_OPTIONS=
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Extra options to supply to gtkdoc-scan.
|
|
Packit |
aea12f |
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
|
|
Packit |
aea12f |
SCAN_OPTIONS=--ignore-decorators=ASN1_API \
|
|
Packit |
aea12f |
--deprecated-guards=ASN1_DISABLE_DEPRECATED
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Extra options to supply to gtkdoc-mkdb
|
|
Packit |
aea12f |
# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
|
|
Packit |
aea12f |
MKDB_OPTIONS=--xml-mode --output-format=xml
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Extra options to supply to gtkdoc-mkhtml
|
|
Packit |
aea12f |
MKHTML_OPTIONS=
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Extra options to supply to gtkdoc-fixref. Normally not needed.
|
|
Packit |
aea12f |
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
|
|
Packit |
aea12f |
FIXXREF_OPTIONS=
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
-include $(top_srcdir)/doc/doc.mk
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Used for dependencies. The docs will be rebuilt if any of these change.
|
|
Packit |
aea12f |
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
|
|
Packit |
aea12f |
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
|
|
Packit |
aea12f |
HFILE_GLOB=$(HEADER_FILES)
|
|
Packit |
aea12f |
CFILE_GLOB=$(C_SOURCE_FILES)
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
|
|
Packit |
aea12f |
# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
|
|
Packit |
aea12f |
EXTRA_HFILES=
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Header files or dirs to ignore when scanning. Use base file/dir names
|
|
Packit |
aea12f |
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
|
|
Packit |
aea12f |
IGNORE_HFILES=
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# find lib -name \*.h -exec basename {} \; | grep -v -e ^abstract.h$ -e ^crypto.h$ -e ^dtls.h$ -e ^gnutls.h$ -e ^openpgp.h$ -e ^pkcs11.h$ -e ^pkcs12.h$ -e ^x509.h$ -e ^ocsp.h$ -e ^tpm.h$ | sort | uniq | sed -e 's/^/\t/' -e 's/$/ \\/'
|
|
Packit |
aea12f |
IGNORE_HFILES += $(top_srcdir)/lib/*.h $(top_srcdir)/lib/*/*.h $(top_srcdir)/libdane/*.h
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Images to copy into HTML directory.
|
|
Packit |
aea12f |
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
|
|
Packit |
aea12f |
HTML_IMAGES=
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Extra files that are included by $(DOC_MAIN_SGML_FILE).
|
|
Packit |
aea12f |
# e.g. content_files=running.xml building.xml changes-2.0.xml
|
|
Packit |
aea12f |
content_files=
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Files where gtk-doc abbreviations (#GtkWidget) are expanded
|
|
Packit |
aea12f |
# e.g. expand_content_files=running.xml
|
|
Packit |
aea12f |
expand_content_files=
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
|
|
Packit |
aea12f |
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
|
|
Packit |
aea12f |
# signals and properties.
|
|
Packit |
aea12f |
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
|
|
Packit |
aea12f |
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
|
|
Packit |
aea12f |
GTKDOC_CFLAGS=
|
|
Packit |
aea12f |
GTKDOC_LIBS=
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# This includes the standard gtk-doc make rules, copied by gtkdocize.
|
|
Packit |
aea12f |
include $(top_srcdir)/gtk-doc.make
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# e.g. EXTRA_DIST += version.xml.in
|
|
Packit |
aea12f |
EXTRA_DIST += version.xml.in
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
# Comment this out if you want 'make check' to test you doc status
|
|
Packit |
aea12f |
# and run some sanity checks
|
|
Packit |
aea12f |
if ENABLE_GTK_DOC
|
|
Packit |
aea12f |
TESTS_ENVIRONMENT = \
|
|
Packit |
aea12f |
DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
|
|
Packit |
aea12f |
SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
|
|
Packit |
aea12f |
#TESTS = $(GTKDOC_CHECK)
|
|
Packit |
aea12f |
endif
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
-include $(top_srcdir)/git.mk
|