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=libcanberra
13
14# The top-level SGML file. You can change this if you want to.
15DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
16
17# The directory containing the source code. Relative to $(srcdir).
18# gtk-doc will search all .c & .h files beneath here for inline comments
19# documenting the functions and macros.
20# e.g. DOC_SOURCE_DIR=../../../gtk
21DOC_SOURCE_DIR=../src
22
23# Extra options to pass to gtkdoc-scangobj. Not normally needed.
24SCANGOBJ_OPTIONS=
25
26# Extra options to supply to gtkdoc-scan.
27# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
28SCAN_OPTIONS=
29
30# Extra options to supply to gtkdoc-mkdb.
31# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
32MKDB_OPTIONS=--sgml-mode --output-format=xml
33
34# Extra options to supply to gtkdoc-mktmpl
35# e.g. MKTMPL_OPTIONS=--only-section-tmpl
36MKTMPL_OPTIONS=
37
38# Extra options to supply to gtkdoc-fixref. Not normally needed.
39# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
40FIXXREF_OPTIONS=
41
42# Used for dependencies. The docs will be rebuilt if any of these change.
43# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
44# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
45HFILE_GLOB=
46CFILE_GLOB=
47
48# Header files to ignore when scanning.
49# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
50IGNORE_HFILES=
51
52# Images to copy into HTML directory.
53# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
54HTML_IMAGES=
55
56# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
57# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
58content_files=
59
60# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
61# These files must be listed here *and* in content_files
62# e.g. expand_content_files=running.sgml
63expand_content_files=
64
65# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
66# Only needed if you are using gtkdoc-scangobj to dynamically query widget
67# signals and properties.
68# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
69# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
70INCLUDES=
71GTKDOC_LIBS=
72
73# This includes the standard gtk-doc make rules, copied by gtkdocize.
74include $(top_srcdir)/gtkdoc/gtk-doc.make
75
76# Other files to distribute
77# e.g. EXTRA_DIST += version.xml.in
78EXTRA_DIST +=
79
80# Files not to distribute
81# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
82# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
83#DISTCLEANFILES +=
84
85# Comment this out if you want your docs-status tested during 'make check'
86#TESTS = $(GTKDOC_CHECK)
87
88