examples/Makefile.am

   1 # -*- mode: makefile -*-
   2 #
   3 # Makefile.am - template makefile for gtk-doc module
   4 # Copyright (C) 2007-2017  Stefan Sauer
   5 #
   6 # This program is free software: you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation, either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 #
  19 # As a special exception, the above copyright owner gives unlimited
  20 # permission to copy, distribute and modify this Makefile.am template.
  21 # You need not follow the terms of the GNU General Public License when
  22 # using or distributing such Makefile.am files, even though portions of
  23 # the text of the Makefile.am appear in them. The GNU General Public
  24 # License (GPL) does govern all other use of the material that constitutes
  25 # the Makefile.am template.
  26
  27 # This is a blank Makefile.am for using gtk-doc.
  28 # Copy this to your project's API docs directory and modify the variables to
  29 # suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
  30 # of using the various options.
  31
  32 # The name of the module, e.g. 'glib'.
  33 DOC_MODULE=
  34
  35 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
  36 #DOC_MODULE_VERSION=2
  37
  38 # The top-level XML file.
  39 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
  40
  41 # Directories containing the source code.
  42 # gtk-doc will search all .c and .h files beneath these paths
  43 # for inline comments documenting functions and macros.
  44 # e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
  45 DOC_SOURCE_DIR=
  46
  47 # Extra options to pass to gtkdoc-scangobj. Normally not needed.
  48 SCANGOBJ_OPTIONS=
  49
  50 # Extra options to supply to gtkdoc-scan.
  51 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
  52 SCAN_OPTIONS=
  53
  54 # Extra options to supply to gtkdoc-mkdb
  55 # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
  56 MKDB_OPTIONS=--xml-mode --output-format=xml
  57
  58 # Extra options to supply to gtkdoc-mkhtml
  59 MKHTML_OPTIONS=
  60
  61 # Extra options to supply to gtkdoc-fixref. Normally not needed.
  62 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  63 FIXXREF_OPTIONS=
  64
  65 # Used for dependencies. The docs will be rebuilt if any of these change.
  66 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  67 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  68 HFILE_GLOB=
  69 CFILE_GLOB=
  70
  71 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
  72 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
  73 EXTRA_HFILES=
  74
  75 # Header files or dirs to ignore when scanning. Use base file/dir names
  76 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
  77 IGNORE_HFILES=
  78
  79 # Images to copy into HTML directory.
  80 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
  81 HTML_IMAGES=
  82
  83 # Extra files that are included by $(DOC_MAIN_SGML_FILE).
  84 # e.g. content_files=running.xml building.xml changes-2.0.xml
  85 content_files=
  86
  87 # Files where gtk-doc abbrevations (#GtkWidget) are expanded
  88 # e.g. expand_content_files=running.xml
  89 expand_content_files=
  90
  91 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
  92 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
  93 # signals and properties.
  94 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
  95 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
  96 GTKDOC_CFLAGS=
  97 GTKDOC_LIBS=
  98
  99 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 100 include $(top_srcdir)/gtk-doc.make
 101
 102 # Comment this out if you don't want 'make check' to test you doc status
 103 # and run some sanity checks
 104 if ENABLE_GTK_DOC
 105 TESTS_ENVIRONMENT = \
 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