docs/gst/Makefile.am

   1 ## Process this file with automake to produce Makefile.in
   2
   3 # The name of the module, e.g. 'glib'.
   4 # DOC_MODULE=gstreamer-@GST_API_VERSION@
   5 DOC_MODULE=gstreamer
   6
   7 # don't want $(DOC_MODULE)-scan.c to be built with -Werror
   8 ERROR_CFLAGS=
   9
  10 BUILT_SOURCES=gstreamer.types
  11
  12 # for upload-doc.mak
  13 DOC=gstreamer
  14 FORMATS=html
  15 html: html-build.stamp
  16 include $(top_srcdir)/common/upload-doc.mak
  17
  18 # The top-level SGML file. Change it if you want.
  19 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
  20
  21 # The files containing the source code. Relative to $(top_srcdir).
  22 # gtk-doc will search all .c & .h files beneath here for inline comments
  23 # documenting functions and macros.
  24 DOC_SOURCE_DIR = $(top_srcdir)/gst
  25
  26 # Extra options to supply to gtkdoc-scan.
  27 SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" \
  28   --ignore-decorators='GST_API'
  29
  30 # Extra options to supply to gtkdoc-mkdb.
  31 MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files=parse
  32
  33 # Extra options to supply to gtkdoc-fixref.
  34 FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html
  35
  36 # Used for dependencies.
  37 HFILE_GLOB=$(top_srcdir)/gst/*.h
  38 CFILE_GLOB=$(top_srcdir)/gst/*.c
  39
  40 # Header files to ignore when scanning. Use base file name, no paths
  41 IGNORE_HFILES= \
  42         gettext.h \
  43         glib-compat-private.h \
  44         glib-compat.h \
  45         gst-i18n-app.h \
  46         gst-i18n-lib.h \
  47         gst_private.h \
  48         gstelementdetails.h \
  49         gstmacros.h \
  50         gstmarshal.h \
  51         math-compat.h \
  52         \
  53         grammar.tab.h \
  54         grammar.tab.pre.h \
  55   parse_lex.h \
  56         types.h \
  57         \
  58         gst-printf.h \
  59         printf-args.h \
  60         printf-extension.h \
  61         printf-parse.h \
  62         vasnprintf.h
  63
  64 gst-universe.svg: gst-universe.dot
  65         -dot -Tsvg $< | sed 's/\(font-size:[0-9]*\.[0-9]*\);/\1px;/g' >$@
  66
  67 # Images to copy into HTML directory.
  68 HTML_IMAGES =
  69
  70 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  71 content_files = building.xml running.xml gst-universe.svg
  72
  73 # Other files to distribute.
  74 extra_files = gst-universe.dot
  75
  76 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
  77 # contains GtkObjects/GObjects and you want to document signals and properties.
  78 GTKDOC_CFLAGS = $(GST_OBJ_CFLAGS) -DGST_USE_UNSTABLE_API
  79 GTKDOC_LIBS = $(GST_OBJ_LIBS) \
  80         $(top_builddir)/gst/libgstreamer-@GST_API_VERSION@.la \
  81         $(top_builddir)/libs/gst/base/libgstbase-@GST_API_VERSION@.la \
  82         $(top_builddir)/libs/gst/controller/libgstcontroller-@GST_API_VERSION@.la \
  83         $(top_builddir)/libs/gst/net/libgstnet-@GST_API_VERSION@.la
  84
  85 GTKDOC_EXTRA_ENVIRONMENT= \
  86     GST_PLUGIN_SCANNER_1_0=$(top_builddir)/libs/gst/helpers/gst-plugin-scanner
  87
  88 # If you need to override some of the declarations, place them in this file
  89 # and uncomment this line.
  90 DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
  91
  92 include $(top_srcdir)/common/gtk-doc.mak
  93
  94 # gtk-doc.mak defines CLEANFILES
  95 CLEANFILES += gst-universe.svg
  96