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-bad
   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 --source-suffixes=c,h,cc,m
  29
  30 # Extra options to supply to gtkdoc-fixref.
  31 FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
  32         --extra-dir=$(GST_PREFIX)/share/gtk-doc/html \
  33         --extra-dir=$(GSTPB_PREFIX)/share/gtk-doc/html
  34
  35 # Used for dependencies.
  36 HFILE_GLOB= \
  37   $(top_srcdir)/gst/*/*.h $(top_srcdir)/ext/*/*.h $(top_srcdir)/sys/*/*.h \
  38   $(top_srcdir)/ext/*/*.hh
  39 CFILE_GLOB= \
  40   $(top_srcdir)/gst/*/*.c $(top_srcdir)/ext/*/*.c $(top_srcdir)/sys/*/*.c \
  41   $(top_srcdir)/ext/*/*.cc $(top_srcdir)/sys/*/*.m
  42
  43 # Header files to ignore when scanning.
  44 IGNORE_HFILES =
  45 IGNORE_CFILES =
  46
  47 # we add all .h files of elements that have signals/args we want
  48 # sadly this also pulls in the private methods - maybe we should
  49 # move those around in the source ?
  50 #
  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 # -> it just works (TM) (ensonic)
  56
  57 # FIXME: not ported yet
  58 #       $(top_srcdir)/ext/gnomevfs/gstgnomevfssink.c
  59
  60 # example code that needs to be converted to xml and placed in xml/
  61 EXAMPLE_CFILES = \
  62         $(top_srcdir)/ext/directfb/dfb-example.c
  63
  64 EXTRA_HFILES = \
  65         $(top_srcdir)/ext/assrender/gstassrender.h \
  66         $(top_srcdir)/ext/celt/gstceltdec.h \
  67         $(top_srcdir)/ext/celt/gstceltenc.h \
  68         $(top_srcdir)/ext/curl/gstcurlbasesink.h \
  69         $(top_srcdir)/ext/curl/gstcurlfilesink.h \
  70         $(top_srcdir)/ext/curl/gstcurlftpsink.h \
  71         $(top_srcdir)/ext/curl/gstcurlhttpsink.h \
  72         $(top_srcdir)/ext/curl/gstcurlsmtpsink.h \
  73         $(top_srcdir)/ext/curl/gstcurltlssink.h \
  74         $(top_srcdir)/ext/dc1394/gstdc1394.h \
  75         $(top_srcdir)/ext/directfb/dfbvideosink.h \
  76         $(top_srcdir)/ext/dts/gstdtsdec.h \
  77         $(top_srcdir)/ext/faac/gstfaac.h \
  78         $(top_srcdir)/ext/faad/gstfaad.h \
  79         $(top_srcdir)/ext/kate/gstkateenc.h \
  80         $(top_srcdir)/ext/kate/gstkatedec.h \
  81         $(top_srcdir)/ext/kate/gstkateparse.h \
  82         $(top_srcdir)/ext/kate/gstkatetag.h \
  83         $(top_srcdir)/ext/kate/gstkatetiger.h \
  84         $(top_srcdir)/ext/ladspa/gstladspa.h \
  85         $(top_srcdir)/ext/musicbrainz/gsttrm.h \
  86         $(top_srcdir)/ext/mimic/gstmimenc.h \
  87         $(top_srcdir)/ext/mimic/gstmimdec.h \
  88         $(top_srcdir)/ext/modplug/gstmodplug.h \
  89         $(top_srcdir)/ext/mpeg2enc/gstmpeg2enc.hh \
  90         $(top_srcdir)/ext/mplex/gstmplex.hh \
  91         $(top_srcdir)/ext/mythtv/gstmythtvsrc.h \
  92         $(top_srcdir)/ext/opencv/gstcvdilate.h \
  93         $(top_srcdir)/ext/opencv/gstcverode.h \
  94         $(top_srcdir)/ext/opencv/gstcvequalizehist.h \
  95         $(top_srcdir)/ext/opencv/gstcvlaplace.h \
  96         $(top_srcdir)/ext/opencv/gstcvsmooth.h \
  97         $(top_srcdir)/ext/opencv/gstcvsobel.h \
  98         $(top_srcdir)/ext/opencv/gstedgedetect.h \
  99         $(top_srcdir)/ext/opencv/gstfaceblur.h \
 100         $(top_srcdir)/ext/opencv/gstfacedetect.h \
 101         $(top_srcdir)/ext/opencv/gstpyramidsegment.h \
 102         $(top_srcdir)/ext/opencv/gsttemplatematch.h \
 103         $(top_srcdir)/ext/opencv/gsttextoverlay.h \
 104         $(top_srcdir)/ext/rsvg/gstrsvgdec.h \
 105         $(top_srcdir)/ext/rsvg/gstrsvgoverlay.h \
 106         $(top_srcdir)/ext/sdl/sdlaudiosink.h \
 107         $(top_srcdir)/ext/sdl/sdlvideosink.h \
 108         $(top_srcdir)/ext/timidity/gsttimidity.h \
 109         $(top_srcdir)/ext/timidity/gstwildmidi.h \
 110         $(top_srcdir)/ext/voaacenc/gstvoaacenc.h \
 111         $(top_srcdir)/ext/voamrwbenc/gstvoamrwbenc.h \
 112         $(top_srcdir)/ext/vp8/gstvp8enc.h \
 113         $(top_srcdir)/ext/vp8/gstvp8dec.h \
 114         $(top_srcdir)/ext/zbar/gstzbar.h \
 115         $(top_srcdir)/gst/aiff/aiffparse.h \
 116         $(top_srcdir)/gst/aiff/aiffmux.h \
 117         $(top_srcdir)/gst/autoconvert/gstautoconvert.h \
 118         $(top_srcdir)/gst/audiovisualizers/gstaudiovisualizer.h \
 119         $(top_srcdir)/gst/audiovisualizers/gstspacescope.h \
 120         $(top_srcdir)/gst/audiovisualizers/gstspectrascope.h \
 121         $(top_srcdir)/gst/audiovisualizers/gstsynaescope.h \
 122         $(top_srcdir)/gst/audiovisualizers/gstwavescope.h \
 123         $(top_srcdir)/gst/camerabin2/gstcamerabin2.h \
 124         $(top_srcdir)/gst/coloreffects/gstcoloreffects.h \
 125         $(top_srcdir)/gst/dataurisrc/gstdataurisrc.h \
 126         $(top_srcdir)/gst/dccp/gstdccpclientsink.h \
 127         $(top_srcdir)/gst/dccp/gstdccpclientsrc.h \
 128         $(top_srcdir)/gst/dccp/gstdccpserversink.h \
 129         $(top_srcdir)/gst/dccp/gstdccpserversrc.h \
 130         $(top_srcdir)/gst/debugutils/fpsdisplaysink.h \
 131         $(top_srcdir)/gst/dtmf/gstdtmfsrc.h \
 132         $(top_srcdir)/gst/dtmf/gstdtmfdetect.h \
 133         $(top_srcdir)/gst/dtmf/gstrtpdtmfsrc.h \
 134         $(top_srcdir)/gst/dtmf/gstrtpdtmfdepay.h \
 135         $(top_srcdir)/gst/dvdspu/gstdvdspu.h \
 136         $(top_srcdir)/gst/festival/gstfestival.h \
 137         $(top_srcdir)/gst/freeze/gstfreeze.h \
 138         $(top_srcdir)/gst/gaudieffects/gstburn.h \
 139         $(top_srcdir)/gst/gaudieffects/gstchromium.h \
 140         $(top_srcdir)/gst/gaudieffects/gstdilate.h \
 141         $(top_srcdir)/gst/gaudieffects/gstdodge.h \
 142         $(top_srcdir)/gst/gaudieffects/gstexclusion.h \
 143         $(top_srcdir)/gst/gaudieffects/gstgaussblur.h \
 144         $(top_srcdir)/gst/gaudieffects/gstplugin.h \
 145         $(top_srcdir)/gst/gaudieffects/gstsolarize.h \
 146         $(top_srcdir)/gst/geometrictransform/gstbulge.h \
 147         $(top_srcdir)/gst/geometrictransform/gstcircle.h \
 148         $(top_srcdir)/gst/geometrictransform/gstdiffuse.h \
 149         $(top_srcdir)/gst/geometrictransform/gstfisheye.h \
 150         $(top_srcdir)/gst/geometrictransform/gstkaleidoscope.h \
 151         $(top_srcdir)/gst/geometrictransform/gstmarble.h \
 152         $(top_srcdir)/gst/geometrictransform/gstmirror.h \
 153         $(top_srcdir)/gst/geometrictransform/gstpinch.h \
 154         $(top_srcdir)/gst/geometrictransform/gstsphere.h \
 155         $(top_srcdir)/gst/geometrictransform/gstsquare.h \
 156         $(top_srcdir)/gst/geometrictransform/gststretch.h \
 157         $(top_srcdir)/gst/geometrictransform/gsttunnel.h \
 158         $(top_srcdir)/gst/geometrictransform/gsttwirl.h \
 159         $(top_srcdir)/gst/geometrictransform/gstwaterripple.h \
 160         $(top_srcdir)/gst/ivfparse/gstivfparse.h \
 161         $(top_srcdir)/gst/jpegformat/gstjpegparse.h \
 162         $(top_srcdir)/gst/liveadder/liveadder.h \
 163         $(top_srcdir)/gst/mxf/mxfdemux.h \
 164         $(top_srcdir)/gst/mxf/mxfmux.h \
 165         $(top_srcdir)/gst/nuvdemux/gstnuvdemux.h \
 166         $(top_srcdir)/gst/pcapparse/gstpcapparse.h \
 167         $(top_srcdir)/gst/rawparse/gstaudioparse.h \
 168         $(top_srcdir)/gst/rawparse/gstvideoparse.h \
 169         $(top_srcdir)/gst/rtpmux/gstrtpmux.h \
 170         $(top_srcdir)/gst/rtpmux/gstrtpdtmfmux.h \
 171         $(top_srcdir)/gst/scaletempo/gstscaletempo.h \
 172         $(top_srcdir)/gst/sdp/gstsdpdemux.h \
 173         $(top_srcdir)/gst/speed/gstspeed.h \
 174         $(top_srcdir)/gst/stereo/gststereo.h \
 175         $(top_srcdir)/gst/videosignal/gstvideoanalyse.h \
 176         $(top_srcdir)/gst/videosignal/gstvideodetect.h \
 177         $(top_srcdir)/gst/videosignal/gstvideomark.h \
 178         $(top_srcdir)/sys/directdraw/gstdirectdrawsink.h \
 179         $(top_srcdir)/sys/dvb/gstdvbsrc.h \
 180         $(top_srcdir)/sys/shm/gstshmsink.h \
 181         $(top_srcdir)/sys/shm/gstshmsrc.h \
 182         $(top_srcdir)/gst-libs/gst/interfaces/photography.h
 183
 184 # Images to copy into HTML directory.
 185 HTML_IMAGES = camerabin.png
 186
 187 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
 188 content_files =
 189
 190 # Other files to distribute.
 191 extra_files =
 192
 193 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
 194 # contains GtkObjects/GObjects and you want to document signals and properties.
 195 GTKDOC_CFLAGS = -DGST_USE_UNSTABLE_API $(GST_PLUGINS_BAD_CFLAGS) $(GST_BASE_CFLAGS) -I$(top_builddir)
 196 GTKDOC_LIBS = \
 197         $(top_builddir)/gst-libs/gst/interfaces/libgstphotography-@GST_API_VERSION@.la \
 198         $(GST_BASE_LIBS)
 199
 200 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
 201 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
 202
 203 # If you need to override some of the declarations, place them in this file
 204 # and uncomment this line.
 205 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
 206 DOC_OVERRIDES =
 207
 208 include $(top_srcdir)/common/gtk-doc-plugins.mak
 209
 210 SUBDIRS =
 211
 212 FIGURES_SOURCEFILES = camerabin.dot
 213 FIGURES_IMAGES      = camerabin.png
 214
 215 EXTRA_DIST += $(FIGURES_SOURCEFILES)
 216
 217 .dot.png:
 218         dot -Tpng $< -o$@
 219
 220 update-figures: $(FIGURES_IMAGES)