docs/reference/plugins/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 = plugins
  13
  14 # The top-level SGML file. You can change this if you want to.
  15 DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
  16
  17 # The directory containing the source code. Relative to $(srcdir).
  18 # gtk-doc will search all .c & .h files beneath here for inline comments
  19 # documenting the functions and macros.
  20 # e.g. DOC_SOURCE_DIR=../../../gtk
  21 DOC_SOURCE_DIR = $(top_srcdir)/gst
  22
  23 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
  24 SCANGOBJ_OPTIONS = --type-init-func="gst_init(NULL, NULL)"
  25
  26 # Extra options to supply to gtkdoc-scan.
  27 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
  28 SCAN_OPTIONS = --deprecated-guards="GST_VAAPI_DISABLE_DEPRECATED"
  29
  30 # Extra options to supply to gtkdoc-mkdb.
  31 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
  32 MKDB_OPTIONS = --sgml-mode --output-format=xml --name-space=$(DOC_MODULE)
  33
  34 # Extra options to supply to gtkdoc-mktmpl
  35 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
  36 MKTMPL_OPTIONS =
  37
  38 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  39 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  40 FIXXREF_OPTIONS = \
  41         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
  42         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
  43         --extra-dir=$(CAIRO_PREFIX)/share/gtk-doc/html/cairo \
  44         --extra-dir=$(PANGO_PREFIX)/share/gtk-doc/html/pango
  45
  46 # Used for dependencies. The docs will be rebuilt if any of these change.
  47 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  48 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  49 HFILE_GLOB = $(top_srcdir)/gst/*/*.h
  50 CFILE_GLOB = $(top_srcdir)/gst/*/*.c
  51
  52 # Header files to ignore when scanning.
  53 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
  54 IGNORE_HFILES = \
  55         $(NULL)
  56
  57 EXTRA_HFILES = \
  58         $(NULL)
  59
  60 # Images to copy into HTML directory.
  61 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
  62 HTML_IMAGES = \
  63         $(NULL)
  64
  65 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  66 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
  67 content_files = \
  68         $(NULL)
  69
  70 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
  71 # These files must be listed here *and* in content_files
  72 # e.g. expand_content_files=running.sgml
  73 expand_content_files = \
  74         $(NULL)
  75
  76 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
  77 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
  78 # signals and properties.
  79 # e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
  80 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
  81
  82 INCLUDES = \
  83         -I$(top_srcdir) \
  84         -I$(top_srcdir)/gst-libs \
  85         -I$(top_srcdir)/gst-libs/gst/vaapi \
  86         $(GLIB_CFLAGS) \
  87         $(GST_CFLAGS) \
  88         $(NULL)
  89
  90 GTKDOC_LIBS = \
  91         $(top_builddir)/gst-libs/gst/vaapi/libgstvaapi-$(GST_MAJORMINOR).la \
  92         $(top_builddir)/gst-libs/gst/vaapi/libgstvaapi-x11-$(GST_MAJORMINOR).la \
  93         $(top_builddir)/gst/vaapi/libgstvaapi.la \
  94         $(GLIB_LIBS) \
  95         $(GST_LIBS) \
  96         $(NULL)
  97
  98 # This includes the standard gtk-doc make rules, copied by gtkdocize.
  99 include $(top_srcdir)/gtk-doc.make
 100
 101 # Other files to distribute
 102 # e.g. EXTRA_DIST += version.xml.in
 103 EXTRA_DIST += \
 104         $(DOC_MODULE)-docs.xml.in \
 105         $(NULL)
 106
 107 # Extra clean files so that maintainer-clean removes *everything*
 108 MAINTAINERCLEANFILES = Makefile.in $(DOC_MODULE)-docs.xml