docs/reference/Makefile.am

   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
  33 # Header files or dirs to ignore when scanning. Use base file/dir names
  34 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
  35 IGNORE_HFILES=`cd $(top_srcdir)/src; find . -path './hb-*/*.h' | sed 's@^.*/@@'`
  36 if HAVE_GOBJECT
  37 else
  38 IGNORE_HFILES+=hb-gobject.h hb-gobject-enums.h hb-gobject-structs.h
  39 endif
  40
  41 # Extra options to supply to gtkdoc-mkdb.
  42 # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
  43 MKDB_OPTIONS=--source-suffixes=h,cc --xml-mode --output-format=xml --ignore-files="$(IGNORE_HFILES)"
  44
  45 # Extra options to supply to gtkdoc-mktmpl
  46 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
  47 MKTMPL_OPTIONS=
  48
  49 # Extra options to supply to gtkdoc-mkhtml
  50 MKHTML_OPTIONS=
  51
  52 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  53 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  54 FIXXREF_OPTIONS=
  55
  56 # Used for dependencies. The docs will be rebuilt if any of these change.
  57 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  58 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  59 HFILE_GLOB=$(top_srcdir)/src/hb.h $(top_srcdir)/src/hb-*.h
  60 CFILE_GLOB=$(top_srcdir)/src/hb-*.cc
  61
  62 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
  63 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
  64 EXTRA_HFILES=$(top_builddir)/src/hb-version.h
  65
  66 # Images to copy into HTML directory.
  67 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
  68 HTML_IMAGES=
  69
  70 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  71 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
  72 content_files= version.xml
  73
  74 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
  75 # These files must be listed here *and* in content_files
  76 # e.g. expand_content_files=running.sgml
  77 expand_content_files=
  78
  79 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
  80 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
  81 # signals and properties.
  82 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
  83 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
  84 GTKDOC_CFLAGS=
  85 GTKDOC_LIBS=$(top_builddir)/src/libharfbuzz.la
  86 if HAVE_GOBJECT
  87 GTKDOC_LIBS+=$(top_builddir)/src/libharfbuzz-gobject.la
  88 endif
  89
  90 # This includes the standard gtk-doc make rules, copied by gtkdocize.
  91 include $(top_srcdir)/gtk-doc.make
  92
  93 # Other files to distribute
  94 # e.g. EXTRA_DIST += version.xml.in
  95 EXTRA_DIST += version.xml.in
  96
  97 # Files not to distribute
  98 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
  99 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
 100 #DISTCLEANFILES +=
 101
 102 # Comment this out if you want 'make check' to test you doc status
 103 # and run some sanity checks
 104 if ENABLE_GTK_DOC
 105 TESTS_ENVIRONMENT = cd $(srcdir) && \
 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