Makefile.am 3.98 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
# -*- mode: makefile -*-
#
# Makefile.am - template makefile for gtk-doc module
# Copyright (C) 2007-2017  Stefan Sauer
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 19 20 21 22 23 24 25
#
# As a special exception, the above copyright owner gives unlimited
# permission to copy, distribute and modify this Makefile.am template.
# You need not follow the terms of the GNU General Public License when
# using or distributing such Makefile.am files, even though portions of
# the text of the Makefile.am appear in them. The GNU General Public
# License (GPL) does govern all other use of the material that constitutes
# the Makefile.am template.
26

27 28 29 30 31 32 33 34
# 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=

35 36 37
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
#DOC_MODULE_VERSION=2

38
# The top-level XML file.
39
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
40

41
# Directories containing the source code.
42 43
# gtk-doc will search all .c and .h files beneath these paths
# for inline comments documenting functions and macros.
44
# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
45 46
DOC_SOURCE_DIR=

47
# Extra options to pass to gtkdoc-scangobj. Normally not needed.
48
SCANGOBJ_OPTIONS=
Damon Chaplin's avatar
Damon Chaplin committed
49

50
# Extra options to supply to gtkdoc-scan.
51
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
52 53
SCAN_OPTIONS=

54
# Extra options to supply to gtkdoc-mkdb
55 56
# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
MKDB_OPTIONS=--xml-mode --output-format=xml
57

58 59 60
# Extra options to supply to gtkdoc-mkhtml
MKHTML_OPTIONS=

61
# Extra options to supply to gtkdoc-fixref. Normally not needed.
62
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
63 64
FIXXREF_OPTIONS=

65 66 67
# 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
68 69 70
HFILE_GLOB=
CFILE_GLOB=

71 72 73 74
# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
EXTRA_HFILES=

75 76
# Header files or dirs to ignore when scanning. Use base file/dir names
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
77 78 79
IGNORE_HFILES=

# Images to copy into HTML directory.
80 81
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
HTML_IMAGES=
82

83 84
# Extra files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.xml building.xml changes-2.0.xml
85 86
content_files=

Rafael Fontenelle's avatar
Rafael Fontenelle committed
87
# Files where gtk-doc abbreviations (#GtkWidget) are expanded
88
# e.g. expand_content_files=running.xml
89 90
expand_content_files=

91 92 93
# 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.
94
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
95
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
96
GTKDOC_CFLAGS=
97 98 99 100 101
GTKDOC_LIBS=

# This includes the standard gtk-doc make rules, copied by gtkdocize.
include $(top_srcdir)/gtk-doc.make

102
# Comment this out if you don't want 'make check' to test you doc status
103
# and run some sanity checks
104
if ENABLE_GTK_DOC
105
TESTS_ENVIRONMENT = \
106
  DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
107
  SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
108
TESTS = $(GTKDOC_CHECK)
109
endif
110 111

-include $(top_srcdir)/git.mk