docs/reference/libs/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 = libs
  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-libs/gst/vaapi
  22
  23 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
  24 SCANGOBJ_OPTIONS = --type-init-func="g_type_init()"
  25
  26 # List files used by scanobj
  27 SCANOBJ_TYPES  = $(srcdir)/$(DOC_MODULE).core.types
  28 SCANOBJ_TYPES += $(srcdir)/$(DOC_MODULE).x11.types
  29 if USE_GLX
  30 SCANOBJ_TYPES += $(srcdir)/$(DOC_MODULE).glx.types
  31 endif
  32
  33 # Extra options to supply to gtkdoc-scan.
  34 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
  35 SCAN_OPTIONS = --deprecated-guards="GST_VAAPI_DISABLE_DEPRECATED"
  36
  37 # Extra options to supply to gtkdoc-mkdb.
  38 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
  39 MKDB_OPTIONS = --sgml-mode --output-format=xml --name-space=$(DOC_MODULE)
  40
  41 # Extra options to supply to gtkdoc-mktmpl
  42 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
  43 MKTMPL_OPTIONS =
  44
  45 # Extra options to supply to gtkdoc-fixref. Not normally needed.
  46 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  47 FIXXREF_OPTIONS = \
  48         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
  49         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
  50         --extra-dir=$(CAIRO_PREFIX)/share/gtk-doc/html/cairo \
  51         --extra-dir=$(PANGO_PREFIX)/share/gtk-doc/html/pango
  52
  53 # Used for dependencies. The docs will be rebuilt if any of these change.
  54 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  55 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  56 HFILE_GLOB = $(top_srcdir)/gst-libs/gst/vaapi/*.h
  57 CFILE_GLOB = $(top_srcdir)/gst-libs/gst/vaapi/*.c $(srcdir)/$(DOC_MODULE).types
  58
  59 # Header files to ignore when scanning.
  60 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
  61 IGNORE_HFILES = \
  62         gstvaapi_priv.h \
  63         gstvaapicompat.h \
  64         gstvaapidebug.h \
  65         gstvaapidecoder_priv.h \
  66         gstvaapidisplay_priv.h \
  67         gstvaapidisplay_glx_priv.h \
  68         gstvaapidisplay_x11_priv.h \
  69         gstvaapiobject_priv.h \
  70         gstvaapiutils.h \
  71         gstvaapiutils_glx.h \
  72         gstvaapiutils_gst.h \
  73         gstvaapiutils_x11.h \
  74         $(NULL)
  75
  76 EXTRA_HFILES = \
  77         $(NULL)
  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         $(NULL)
  83
  84 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  85 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
  86 content_files = \
  87         $(NULL)
  88
  89 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
  90 # These files must be listed here *and* in content_files
  91 # e.g. expand_content_files=running.sgml
  92 expand_content_files = \
  93         $(NULL)
  94
  95 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
  96 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
  97 # signals and properties.
  98 # e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
  99 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
 100
 101 INCLUDES = \
 102         $(GLIB_CFLAGS) \
 103         $(GST_CFLAGS) \
 104         -I$(top_srcdir) \
 105         -I$(top_srcdir)/gst-libs \
 106         -I$(top_srcdir)/gst-libs/gst/vaapi
 107
 108 GTKDOC_LIBS = \
 109         $(GLIB_LIBS) \
 110         $(GST_LIBS) \
 111         $(top_builddir)/gst-libs/gst/vaapi/libgstvaapi-$(GST_MAJORMINOR).la
 112
 113 GTKDOC_LIBS += \
 114         $(top_builddir)/gst-libs/gst/vaapi/libgstvaapi-x11-$(GST_MAJORMINOR).la
 115
 116 if USE_GLX
 117 GTKDOC_LIBS += \
 118         $(top_builddir)/gst-libs/gst/vaapi/libgstvaapi-glx-$(GST_MAJORMINOR).la
 119 endif
 120
 121 $(srcdir)/$(DOC_MODULE).types: $(SCANOBJ_TYPES)
 122         cat $(SCANOBJ_TYPES) > $@
 123
 124 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 125 include $(top_srcdir)/gtk-doc.make
 126
 127 # Other files to distribute
 128 # e.g. EXTRA_DIST += version.xml.in
 129 EXTRA_DIST += \
 130         libs-docs.xml.in \
 131         libs.core.types \
 132         libs.x11.types \
 133         libs.glx.types \
 134         $(NULL)
 135
 136 DISTCLEANFILES = $(srcdir)/$(DOC_MODULE).types
 137 BUILT_SOURCES  = $(srcdir)/$(DOC_MODULE).types
 138
 139 # Extra clean files so that maintainer-clean removes *everything*
 140 MAINTAINERCLEANFILES = Makefile.in lib-docs.xml