docs/plugins/Makefile.am

   1 GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
   2
   3 ## Process this file with automake to produce Makefile.in
   4
   5 # The name of the module, e.g. 'glib'.
   6 #DOC_MODULE=gst-plugins-libs-@GST_API_VERSION@
   7 MODULE=gstreamer
   8 DOC_MODULE=$(MODULE)-plugins
   9
  10 # for upload-doc.mak
  11 DOC=$(MODULE)-plugins
  12 FORMATS=html
  13 html: html-build.stamp
  14 include $(top_srcdir)/common/upload-doc.mak
  15
  16 # Extra environment needed for Core only...
  17 INSPECT_EXTRA_ENVIRONMENT= \
  18     GST_PLUGIN_SCANNER_1_0=$(top_builddir)/libs/gst/helpers/gst-plugin-scanner
  19
  20 # The top-level SGML file. Change it if you want.
  21 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
  22
  23 # The directory containing the source code.
  24 # gtk-doc will search all .c & .h files beneath here for inline comments
  25 # documenting functions and macros.
  26 DOC_SOURCE_DIR = $(top_srcdir)/plugins/elements
  27
  28 # Extra options to supply to gtkdoc-scan.
  29 SCAN_OPTIONS=
  30
  31 # Extra options to supply to gtkdoc-mkdb.
  32 MKDB_OPTIONS=--sgml-mode
  33
  34 # Extra options to supply to gtkdoc-fixref.
  35 FIXXREF_OPTIONS=--extra-dir=$(top_builddir)/docs/gst/html \
  36         --extra-dir=$(top_builddir)/docs/libs/html \
  37         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
  38         --extra-dir=$(datadir)/gtk-doc/html
  39
  40 # Used for dependencies.
  41 HFILE_GLOB=$(top_srcdir)/plugins/elements/*.h
  42 CFILE_GLOB=$(top_srcdir)/plugins/elements/*.c
  43
  44 # Header files to ignore when scanning.
  45 IGNORE_HFILES =
  46 IGNORE_CFILES =
  47
  48 # we add all .h files of elements that have signals/args we want
  49 # sadly this also pulls in the private methods - maybe we should
  50 # move those around in the source ?
  51 # also, we should add some stuff here conditionally based on whether
  52 # or not the plugin will actually build
  53 # but I'm not sure about that - it might be this Just Works given that
  54 # the registry won't have the element
  55
  56 EXTRA_HFILES = \
  57         $(top_srcdir)/plugins/elements/gstcapsfilter.h \
  58         $(top_srcdir)/plugins/elements/gstdownloadbuffer.h \
  59         $(top_srcdir)/plugins/elements/gstfakesrc.h \
  60         $(top_srcdir)/plugins/elements/gstfakesink.h \
  61         $(top_srcdir)/plugins/elements/gstfdsink.h \
  62         $(top_srcdir)/plugins/elements/gstfdsrc.h \
  63         $(top_srcdir)/plugins/elements/gstfilesrc.h \
  64         $(top_srcdir)/plugins/elements/gstfilesink.h \
  65         $(top_srcdir)/plugins/elements/gstidentity.h \
  66         $(top_srcdir)/plugins/elements/gstinputselector.h \
  67         $(top_srcdir)/plugins/elements/gstmultiqueue.h \
  68         $(top_srcdir)/plugins/elements/gstoutputselector.h \
  69         $(top_srcdir)/plugins/elements/gstqueue.h \
  70         $(top_srcdir)/plugins/elements/gstqueue2.h \
  71         $(top_srcdir)/plugins/elements/gsttypefindelement.h \
  72         $(top_srcdir)/plugins/elements/gsttee.h \
  73         $(top_srcdir)/plugins/elements/gstvalve.h
  74
  75 # Images to copy into HTML directory.
  76 HTML_IMAGES =
  77
  78 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  79 content_files =
  80
  81 # Other files to distribute.
  82 extra_files =
  83
  84 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
  85 # contains GtkObjects/GObjects and you want to document signals and properties.
  86 GTKDOC_CFLAGS = $(GST_OBJ_CFLAGS) -I$(top_builddir) -I$(top_builddir)/libs
  87 GTKDOC_LIBS = $(GST_OBJ_LIBS)
  88
  89 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
  90 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
  91
  92 # If you need to override some of the declarations, place them in this file
  93 # and uncomment this line.
  94 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
  95 DOC_OVERRIDES =
  96
  97 include $(top_srcdir)/common/gtk-doc-plugins.mak