/docs/reference/Makefile.am

  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=ftk
 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, relative to $(srcdir).
 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=../../../gtk ../../../gdk
 25DOC_SOURCE_DIR=$(top_srcdir)/src
 26
 27# Extra options to pass to gtkdoc-scangobj. Not normally needed.
 28SCANGOBJ_OPTIONS=
 29
 30# Extra options to supply to gtkdoc-scan.
 31# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
 32SCAN_OPTIONS=
 33
 34# Extra options to supply to gtkdoc-mkdb.
 35# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
 36MKDB_OPTIONS=--sgml-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=
 53CFILE_GLOB=
 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 to ignore when scanning. Use base file name, no paths
 60# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
 61IGNORE_HFILES=
 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 abbrevations (#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 your docs-status tested during 'make check'
 97if ENABLE_GTK_DOC
 98#TESTS_ENVIRONMENT = cd $(srcsrc) &&
 99#TESTS = $(GTKDOC_CHECK)
100endif
101
102-include $(top_srcdir)/git.mk