blob: dc6dd3e5ecb020c5c497a124f0151a47a776ea87 [file] [log] [blame]
bigbiff7b4c7a62015-01-01 19:44:14 -05001## Process this file with automake to produce Makefile.in
2
3# We require automake 1.10 at least.
4AUTOMAKE_OPTIONS = 1.10
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=libblkid
13
14# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
15#DOC_MODULE_VERSION=2
16
17# The top-level SGML file. You can change this if you want to.
18DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
19
20# The directory containing the source code. Relative to $(srcdir).
21# gtk-doc will search all .c & .h files beneath here for inline comments
22# documenting the functions and macros.
23# e.g. DOC_SOURCE_DIR=../../../gtk
24DOC_SOURCE_DIR=../src
25
26# Extra options to pass to gtkdoc-scangobj. Not normally needed.
27SCANGOBJ_OPTIONS=
28
29# Extra options to supply to gtkdoc-scan.
30# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
31SCAN_OPTIONS=--deprecated-guards="BLKID_DISABLE_DEPRECATED"
32
33# Extra options to supply to gtkdoc-mkdb.
34# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
35MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space blkid
36
37# Extra options to supply to gtkdoc-mktmpl
38# e.g. MKTMPL_OPTIONS=--only-section-tmpl
39MKTMPL_OPTIONS=
40
41# Extra options to supply to gtkdoc-mkhtml
42MKHTML_OPTIONS=
43
44# Extra options to supply to gtkdoc-fixref. Not normally needed.
45# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
46FIXXREF_OPTIONS=
47
48# Used for dependencies. The docs will be rebuilt if any of these change.
49# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
50# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
51HFILE_GLOB=$(top_builddir)/libblkid/src/blkid.h
52CFILE_GLOB=$(top_srcdir)/libblkid/src/*.c
53
54# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
55# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
56EXTRA_HFILES=
57
58# Header files to ignore when scanning. Use base file name, no paths
59# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
60IGNORE_HFILES=blkidP.h partitions.h superblocks.h \
61 topology.h aix.h dos.h iso9660.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 = $(builddir)/version.xml $(srcdir)/libblkid-config.xml
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)/config/gtk-doc.make
86
87# Other files to distribute
88# e.g. EXTRA_DIST += version.xml.in
89EXTRA_DIST += version.xml.in $(srcdir)/libblkid-config.xml
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
94DISTCLEANFILES += version.xml
95