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=gst-plugins-base
   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 # 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)/gst $(top_srcdir)/ext $(top_srcdir)/sys
  23
  24 # Extra options to supply to gtkdoc-scan.
  25 SCAN_OPTIONS=
  26
  27 # Extra options to supply to gtkdoc-mkdb.
  28 MKDB_OPTIONS=--sgml-mode
  29
  30 # Extra options to supply to gtkdoc-fixref.
  31 FIXXREF_OPTIONS=--extra-dir=$(top_builddir)/docs/libs/html \
  32         --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
  33         --extra-dir=$(GST_PREFIX)/share/gtk-doc/html \
  34         --extra-dir=$(datadir)/gtk-doc/html
  35
  36 # Used for dependencies.
  37 HFILE_GLOB=$(top_srcdir)/gst/*/*.h $(top_srcdir)/ext/*/*.h $(top_srcdir)/sys/*/*.h
  38 CFILE_GLOB=$(top_srcdir)/gst/*/*.c $(top_srcdir)/ext/*/*.c $(top_srcdir)/sys/*/*.c
  39
  40 # Header files to ignore when scanning.
  41 IGNORE_HFILES = avcodec.h dsputil.h arch.h speex_resampler.h speex_resampler_wrapper.h fixed_arm4.h fixed_arm5e.h fixed_bfin.h fixed_debug.h fixed_generic.h resample_sse.h
  42 IGNORE_CFILES = utils.c mem.c imgconvert.c
  43
  44 # we add all .h files of elements that have signals/args we want
  45 # sadly this also pulls in the private methods - maybe we should
  46 # move those around in the source ?
  47 # also, we should add some stuff here conditionally based on whether
  48 # or not the plugin will actually build
  49 # but I'm not sure about that - it might be this Just Works given that
  50 # the registry won't have the element
  51
  52 EXTRA_HFILES = \
  53         $(top_srcdir)/ext/alsa/gstalsamixerelement.h \
  54         $(top_srcdir)/ext/alsa/gstalsasink.h \
  55         $(top_srcdir)/ext/alsa/gstalsasrc.h \
  56         $(top_srcdir)/ext/cdparanoia/gstcdparanoiasrc.h \
  57         $(top_srcdir)/ext/ogg/gstoggdemux.h \
  58         $(top_srcdir)/ext/ogg/gstoggmux.h \
  59         $(top_srcdir)/ext/pango/gstclockoverlay.h \
  60         $(top_srcdir)/ext/pango/gsttextoverlay.h \
  61         $(top_srcdir)/ext/pango/gsttextrender.h \
  62         $(top_srcdir)/ext/pango/gsttimeoverlay.h \
  63         $(top_srcdir)/ext/theora/gsttheoradec.h \
  64         $(top_srcdir)/ext/theora/gsttheoraenc.h \
  65         $(top_srcdir)/ext/theora/gsttheoraparse.h \
  66         $(top_srcdir)/ext/vorbis/gstvorbisdec.h \
  67         $(top_srcdir)/ext/vorbis/gstvorbisenc.h \
  68         $(top_srcdir)/ext/vorbis/gstvorbisparse.h \
  69         $(top_srcdir)/ext/vorbis/gstvorbistag.h \
  70         $(top_srcdir)/gst/adder/gstadder.h \
  71         $(top_srcdir)/gst/audioconvert/audioconvert.h \
  72         $(top_srcdir)/gst/audioconvert/gstaudioconvert.h \
  73         $(top_srcdir)/gst/audiotestsrc/gstaudiotestsrc.h \
  74         $(top_srcdir)/gst/encoding/gstencodebin.h \
  75         $(top_srcdir)/gst/gdp/gstgdpdepay.h \
  76         $(top_srcdir)/gst/gdp/gstgdppay.h \
  77         $(top_srcdir)/gst/gio/gstgiosink.h \
  78         $(top_srcdir)/gst/gio/gstgiosrc.h \
  79         $(top_srcdir)/gst/gio/gstgiostreamsink.h \
  80         $(top_srcdir)/gst/gio/gstgiostreamsrc.h \
  81         $(top_srcdir)/gst/playback/gstplay-enum.h \
  82         $(top_srcdir)/gst/playback/gstsubtitleoverlay.h \
  83         $(top_srcdir)/gst/audiorate/gstaudiorate.h \
  84         $(top_srcdir)/gst/audioresample/gstaudioresample.h \
  85         $(top_srcdir)/gst/tcp/gstmultisocketsink.h \
  86         $(top_srcdir)/gst/tcp/gsttcpclientsrc.h \
  87         $(top_srcdir)/gst/tcp/gsttcpclientsink.h \
  88         $(top_srcdir)/gst/tcp/gsttcpserversrc.h \
  89         $(top_srcdir)/gst/tcp/gsttcpserversink.h \
  90         $(top_builddir)/gst/tcp/gsttcp-enumtypes.h \
  91         $(top_srcdir)/gst/tcp/gsttcp.h \
  92         $(top_srcdir)/gst/videorate/gstvideorate.h \
  93         $(top_srcdir)/gst/videoscale/gstvideoscale.h \
  94         $(top_srcdir)/gst/videotestsrc/gstvideotestsrc.h \
  95         $(top_srcdir)/gst/volume/gstvolume.h \
  96         $(top_srcdir)/sys/ximage/ximagesink.h \
  97         $(top_srcdir)/sys/xvimage/xvimagesink.h \
  98         $(top_srcdir)/gst-libs/gst/app/gstappsrc.h \
  99         $(top_srcdir)/gst-libs/gst/app/gstappsink.h
 100
 101 # Images to copy into HTML directory.
 102 HTML_IMAGES =
 103
 104 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
 105 content_files =
 106
 107 # Other files to distribute.
 108 extra_files =
 109
 110 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
 111 # contains GtkObjects/GObjects and you want to document signals and properties.
 112 GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir) -I$(top_builddir)/gst-libs
 113 GTKDOC_LIBS = $(GST_BASE_LIBS)
 114
 115 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
 116 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
 117
 118 # If you need to override some of the declarations, place them in this file
 119 DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
 120
 121 include $(top_srcdir)/common/gtk-doc-plugins.mak