1 # Process this file with automake to produce Makefile.in
3 # We require automake 1.6 at least.
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.
11 # The name of the module, e.g. 'glib'.
14 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
15 #DOC_MODULE_VERSION=$(HB_VERSION_MAJOR)
17 # The top-level SGML file. You can change this if you want to.
18 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
20 # Directories containing the source code.
21 # gtk-doc will search all .c and .h files beneath these paths
22 # for inline comments documenting functions and macros.
23 # e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
24 DOC_SOURCE_DIR=$(top_srcdir)/src $(top_builddir)/src
26 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
29 # Extra options to supply to gtkdoc-scan.
30 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
31 SCAN_OPTIONS=--rebuild-types --deprecated-guards="HB_DISABLE_DEPRECATED" \
32 --ignore-decorators="HB_EXTERN"
34 # Header files or dirs to ignore when scanning. Use base file/dir names
35 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
36 IGNORE_HFILES=`cd $(top_srcdir)/src; find . -path './*/*.h' | sed 's@^.*/@@'`
39 IGNORE_HFILES+=hb-gobject.h hb-gobject-enums.h hb-gobject-structs.h
42 # Extra options to supply to gtkdoc-mkdb.
43 # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
44 MKDB_OPTIONS=--source-suffixes=h,cc --xml-mode --output-format=xml --ignore-files="$(IGNORE_HFILES)"
46 # Extra options to supply to gtkdoc-mktmpl
47 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
50 # Extra options to supply to gtkdoc-mkhtml
53 # Extra options to supply to gtkdoc-fixref. Not normally needed.
54 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
57 # Used for dependencies. The docs will be rebuilt if any of these change.
58 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
59 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
60 HFILE_GLOB=$(top_srcdir)/src/hb.h $(top_srcdir)/src/hb-*.h
61 CFILE_GLOB=$(top_srcdir)/src/hb-*.cc
63 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
64 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
66 # Images to copy into HTML directory.
67 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
72 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
73 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
75 usermanual-what-is-harfbuzz.xml \
76 usermanual-install-harfbuzz.xml \
77 usermanual-getting-started.xml \
78 usermanual-glyph-information.xml \
79 usermanual-shaping-concepts.xml \
80 usermanual-object-model.xml \
81 usermanual-buffers-language-script-and-direction.xml \
82 usermanual-fonts-and-faces.xml \
83 usermanual-opentype-features.xml \
84 usermanual-clusters.xml \
85 usermanual-utilities.xml \
86 usermanual-integration.xml \
89 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
90 # These files must be listed here *and* in content_files
91 # e.g. expand_content_files=running.sgml
94 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
95 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
96 # signals and properties.
97 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
98 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
100 GTKDOC_LIBS=$(top_builddir)/src/libharfbuzz.la
102 GTKDOC_LIBS+=$(top_builddir)/src/libharfbuzz-gobject.la
105 # This includes the standard gtk-doc make rules, copied by gtkdocize.
106 include $(top_srcdir)/gtk-doc.make
108 # Other files to distribute
109 # e.g. EXTRA_DIST += version.xml.in
110 EXTRA_DIST += version.xml.in meson.build
112 # Files not to distribute
113 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
114 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
117 # Comment this out if you don't want 'make check' to test you doc status
118 # and run some sanity checks
120 TESTS_ENVIRONMENT = cd $(srcdir) && \
121 DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
122 SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
123 #TESTS = $(GTKDOC_CHECK)
126 -include $(top_srcdir)/git.mk