docs/libs/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-libs-@GST_MAJORMINOR@
   5 DOC_MODULE=gstreamer-libs
   6
   7 # don't want $(DOC_MODULE)-scan.c to be built with -Werror
   8 ERROR_CFLAGS=
   9
  10 # for upload-doc.mak
  11 DOC=gstreamer-libs
  12 FORMATS=html
  13 html: html-build.stamp
  14 include $(top_srcdir)/common/upload-doc.mak
  15
  16 # The top-level SGML file. Change it if you want.
  17 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
  18
  19 # The directory containing the source code.
  20 # gtk-doc will search all .c & .h files beneath here for inline comments
  21 # documenting functions and macros.
  22 DOC_SOURCE_DIR=$(top_srcdir)/libs/gst
  23
  24 # Extra options to supply to gtkdoc-scan.
  25 SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
  26
  27 # Extra options to supply to gtkdoc-mkdb.
  28 MKDB_OPTIONS=--sgml-mode --output-format=xml
  29
  30 # Extra options to supply to gtkdoc-fixref.
  31 FIXXREF_OPTIONS=--extra-dir=$(top_builddir)/docs/gst/html \
  32         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
  33         --extra-dir=$(datadir)/gtk-doc/html
  34
  35 # Used for dependencies.
  36 HFILE_GLOB=$(top_srcdir)/libs/gst/*/*.h
  37 CFILE_GLOB=$(top_srcdir)/libs/gst/*/*.c
  38
  39 # Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj.
  40 SCANOBJ_OPTIONS=--type-init-func="g_type_init();gst_init(&argc,&argv)"
  41
  42 # Header files to ignore when scanning.
  43 IGNORE_HFILES = \
  44         gstinterpolationcontrolsourceprivate.h \
  45         gstlfocontrolsourceprivate.h \
  46         gstcontrollerprivate.h \
  47         gstgetbits_inl.h \
  48         dp-private.h
  49
  50 # Images to copy into HTML directory.
  51 HTML_IMAGES = gdp-header.png
  52
  53 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  54 content_files =
  55
  56 # Other files to distribute.
  57 extra_files =
  58
  59 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
  60 # contains GtkObjects/GObjects and you want to document signals and properties.
  61 GTKDOC_CFLAGS = -I$(top_builddir) -I$(top_builddir)/libs $(GST_OBJ_CFLAGS)
  62 GTKDOC_LIBS = \
  63         $(top_builddir)/libs/gst/controller/libgstcontroller-@GST_MAJORMINOR@.la \
  64         $(top_builddir)/libs/gst/base/libgstbase-@GST_MAJORMINOR@.la \
  65         $(top_builddir)/libs/gst/net/libgstnet-@GST_MAJORMINOR@.la \
  66         $(GST_OBJ_LIBS)
  67
  68 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
  69 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
  70
  71 GTKDOC_EXTRA_ENVIRONMENT= \
  72     GST_PLUGIN_SCANNER=$(top_builddir)/libs/gst/helpers/gst-plugin-scanner
  73
  74 # If you need to override some of the declarations, place them in this file
  75 # and uncomment this line.
  76 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
  77 DOC_OVERRIDES =
  78
  79 include $(top_srcdir)/common/gtk-doc.mak