1## Process this file with automake to produce Makefile.in 2 3# We require automake 1.6 at least. 4AUTOMAKE_OPTIONS = 1.6 5 6# This is a blank Makefile.am for using gtk-doc. 7# Copy this to your project's API docs directory and modify the variables to 8# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples 9# of using the various options. 10 11# The name of the module, e.g. 'glib'. 12DOC_MODULE=libpsl 13 14# Uncomment for versioned docs and specify the version of the module, e.g. '2'. 15#DOC_MODULE_VERSION=2 16 17 18# The top-level SGML file. You can change this if you want to. 19DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml 20 21# Directories containing the source code. 22# gtk-doc will search all .c and .h files beneath these paths 23# for inline comments documenting functions and macros. 24# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk 25DOC_SOURCE_DIR=$(top_srcdir)/src $(top_srcdir)/include 26 27# Extra options to pass to gtkdoc-scangobj. Not normally needed. 28#SCANGOBJ_OPTIONS=--ignore-decorators="UNUSED_RESULT|CONST|PURE" 29 30# Extra options to supply to gtkdoc-scan. 31# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" 32SCAN_OPTIONS=--ignore-decorators="G_GNUC_PSL_UNUSED" 33 34# Extra options to supply to gtkdoc-mkdb. 35# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml 36MKDB_OPTIONS=--xml-mode --output-format=xml 37 38# Extra options to supply to gtkdoc-mktmpl 39# e.g. MKTMPL_OPTIONS=--only-section-tmpl 40MKTMPL_OPTIONS= 41 42# Extra options to supply to gtkdoc-mkhtml 43MKHTML_OPTIONS= 44 45# Extra options to supply to gtkdoc-fixref. Not normally needed. 46# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html 47FIXXREF_OPTIONS= 48 49# Used for dependencies. The docs will be rebuilt if any of these change. 50# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h 51# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c 52HFILE_GLOB=$(top_srcdir)/include/*.h 53CFILE_GLOB=$(top_srcdir)/src/*.c 54 55# Extra header to include when scanning, which are not under DOC_SOURCE_DIR 56# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h 57EXTRA_HFILES= 58 59# Header files or dirs to ignore when scanning. Use base file/dir names 60# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code 61IGNORE_HFILES=private.h 62 63# Images to copy into HTML directory. 64# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png 65HTML_IMAGES= 66 67# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). 68# e.g. content_files=running.sgml building.sgml changes-2.0.sgml 69content_files= 70 71# SGML files where gtk-doc abbreviations (#GtkWidget) are expanded 72# These files must be listed here *and* in content_files 73# e.g. expand_content_files=running.sgml 74expand_content_files= 75 76# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. 77# Only needed if you are using gtkdoc-scangobj to dynamically query widget 78# signals and properties. 79# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) 80# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) 81GTKDOC_CFLAGS= 82GTKDOC_LIBS= 83 84# This includes the standard gtk-doc make rules, copied by gtkdocize. 85include $(top_srcdir)/gtk-doc.make 86 87# Other files to distribute 88# e.g. EXTRA_DIST += version.xml.in 89EXTRA_DIST += 90 91# Files not to distribute 92# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types 93# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt 94#DISTCLEANFILES += 95 96# Comment this out if you want 'make check' to test you doc status 97# and run some sanity checks 98if ENABLE_GTK_DOC 99TESTS_ENVIRONMENT = cd $(srcdir) && \ 100 DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \ 101 SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir) 102#TESTS = $(GTKDOC_CHECK) 103endif 104 105-include $(top_srcdir)/git.mk 106 107theMANS = 108man_MANS = 109 110if ENABLE_GTK_DOC 111if ENABLE_MAN 112 113theMANS += libpsl.3 114man_MANS += docs $(theMANS) 115 116# make distcheck -jn randomly breaks 117.NOTPARALLEL: 118 119%.3: sgml-build.stamp 120 @file=xml/`basename $@|cut -d'.' -f1`.xml; \ 121 @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $$file 122 123endif 124endif 125 126BUILT_EXTRA_DIST = $(theMANS) 127EXTRA_DIST += $(theMANS) 128CLEANFILES ?= 129CLEANFILES += $(theMANS) libpsl-overrides.txt libpsl-decl.txt libpsl-decl-list.txt 130 131clean-local: 132 rm -rf xml html 133 134dist-hook-local: all-local 135 136libpsl-docs-clean: clean 137 cd $(srcdir) && rm -rf xml html 138
