examples/Makefile.am

   1 # This is a blank Makefile.am for using gtk-doc.
   2 # Copy this to your project's API docs directory and modify the variables to
   3 # suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
   4 # of using the various options.
   5
   6 # The name of the module, e.g. 'glib'.
   7 DOC_MODULE=
   8
   9 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
  10 #DOC_MODULE_VERSION=2
  11
  12 # The top-level XML file.
  13 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
  14
  15 # Directories containing the source code.
  16 # gtk-doc will search all .c and .h files beneath these paths
  17 # for inline comments documenting functions and macros.
  18 # e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
  19 DOC_SOURCE_DIR=
  20
  21 # Extra options to pass to gtkdoc-scangobj. Normally not needed.
  22 SCANGOBJ_OPTIONS=
  23
  24 # Extra options to supply to gtkdoc-scan.
  25 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
  26 SCAN_OPTIONS=
  27
  28 # Extra options to supply to gtkdoc-mkdb
  29 # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
  30 MKDB_OPTIONS=--xml-mode --output-format=xml
  31
  32 # Extra options to supply to gtkdoc-mkhtml
  33 MKHTML_OPTIONS=
  34
  35 # Extra options to supply to gtkdoc-fixref. Normally not needed.
  36 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  37 FIXXREF_OPTIONS=
  38
  39 # Used for dependencies. The docs will be rebuilt if any of these change.
  40 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  41 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  42 HFILE_GLOB=
  43 CFILE_GLOB=
  44
  45 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
  46 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
  47 EXTRA_HFILES=
  48
  49 # Header files or dirs to ignore when scanning. Use base file/dir names
  50 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
  51 IGNORE_HFILES=
  52
  53 # Images to copy into HTML directory.
  54 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
  55 HTML_IMAGES=
  56
  57 # Extra files that are included by $(DOC_MAIN_SGML_FILE).
  58 # e.g. content_files=running.xml building.xml changes-2.0.xml
  59 content_files=
  60
  61 # Files where gtk-doc abbrevations (#GtkWidget) are expanded
  62 # e.g. expand_content_files=running.xml
  63 expand_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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
  69 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
  70 GTKDOC_CFLAGS=
  71 GTKDOC_LIBS=
  72
  73 # This includes the standard gtk-doc make rules, copied by gtkdocize.
  74 include $(top_srcdir)/gtk-doc.make
  75
  76 # Comment this out if you want 'make check' to test you doc status
  77 # and run some sanity checks
  78 if ENABLE_GTK_DOC
  79 TESTS_ENVIRONMENT = \
  80   DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
  81   SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
  82 TESTS = $(GTKDOC_CHECK)
  83 endif
  84
  85 -include $(top_srcdir)/git.mk