1 # Process this file with automake to produce Makefile.in 2 3 # We require automake 1.6 at least. 4 AUTOMAKE_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'. 12 DOC_MODULE=harfbuzz 13 14 # Uncomment for versioned docs and specify the version of the module, e.g. '2'. 15 #DOC_MODULE_VERSION=$(HB_VERSION_MAJOR) 16 17 # The top-level SGML file. You can change this if you want to. 18 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml 19 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 25 26 # Extra options to pass to gtkdoc-scangobj. Not normally needed. 27 SCANGOBJ_OPTIONS= 28 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" 33 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 './hb-*/*.h' | sed 's@^.*/@@'` 37 if HAVE_GOBJECT 38 else 39 IGNORE_HFILES+=hb-gobject.h hb-gobject-enums.h hb-gobject-structs.h 40 endif 41 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)" 45 46 # Extra options to supply to gtkdoc-mktmpl 47 # e.g. MKTMPL_OPTIONS=--only-section-tmpl 48 MKTMPL_OPTIONS= 49 50 # Extra options to supply to gtkdoc-mkhtml 51 MKHTML_OPTIONS= 52 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 55 FIXXREF_OPTIONS= 56 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 62 63 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR 64 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h 65 EXTRA_HFILES=$(top_builddir)/src/hb-version.h 66 67 # Images to copy into HTML directory. 68 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png 69 HTML_IMAGES= \ 70 HarfBuzz.png 71 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 74 content_files= \ 75 usermanual-buffers-language-script-and-direction.xml \ 76 usermanual-clusters.xml \ 77 usermanual-fonts-and-faces.xml \ 78 usermanual-glyph-information.xml \ 79 usermanual-hello-harfbuzz.xml \ 80 usermanual-install-harfbuzz.xml \ 81 usermanual-opentype-features.xml \ 82 usermanual-what-is-harfbuzz.xml \ 83 version.xml 84 85 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded 86 # These files must be listed here *and* in content_files 87 # e.g. expand_content_files=running.sgml 88 expand_content_files= 89 90 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. 91 # Only needed if you are using gtkdoc-scangobj to dynamically query widget 92 # signals and properties. 93 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) 94 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) 95 GTKDOC_CFLAGS= 96 GTKDOC_LIBS=$(top_builddir)/src/libharfbuzz.la 97 if HAVE_GOBJECT 98 GTKDOC_LIBS+=$(top_builddir)/src/libharfbuzz-gobject.la 99 endif 100 101 # This includes the standard gtk-doc make rules, copied by gtkdocize. 102 include $(top_srcdir)/gtk-doc.make 103 104 # Other files to distribute 105 # e.g. EXTRA_DIST += version.xml.in 106 EXTRA_DIST += version.xml.in 107 108 # Files not to distribute 109 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types 110 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt 111 #DISTCLEANFILES += 112 113 # Comment this out if you want 'make check' to test you doc status 114 # and run some sanity checks 115 if ENABLE_GTK_DOC 116 TESTS_ENVIRONMENT = cd $(srcdir) && \ 117 DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \ 118 SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir) 119 #TESTS = $(GTKDOC_CHECK) 120 endif 121 122 -include $(top_srcdir)/git.mk 123