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_MAJORMINOR@
   7 MODULE=gst-plugins-good
   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 # generated basefiles
  17 #basefiles = \
  18 ##              $(DOC_MODULE).types \
  19 #               $(DOC_MODULE)-sections.txt \
  20 #               $(DOC_MODULE)-docs.sgml
  21
  22 # ugly hack to make -unused.sgml work
  23 #unused-build.stamp:
  24 #       BUILDDIR=`pwd` && \
  25 #       cd $(srcdir)/tmpl && \
  26 #       ln -sf gstreamer-libs-unused.sgml \
  27 #               $$BUILDDIR/tmpl/gstreamer-libs-@GST_MAJORMINOR@-unused.sgml
  28 #       touch unused-build.stamp
  29
  30 # these rules are added to create parallel docs using GST_MAJORMINOR
  31 #$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs%
  32 #       cp $< $@
  33
  34 #CLEANFILES = $(basefiles)
  35
  36 # The top-level SGML file. Change it if you want.
  37 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
  38
  39 # The directory containing the source code. Relative to $(top_srcdir).
  40 # gtk-doc will search all .c & .h files beneath here for inline comments
  41 # documenting functions and macros.
  42 DOC_SOURCE_DIR = $(top_srcdir)
  43
  44 # Extra options to supply to gtkdoc-scan.
  45 SCAN_OPTIONS=
  46
  47 # Extra options to supply to gtkdoc-mkdb.
  48 MKDB_OPTIONS=--sgml-mode --source-suffixes=c,h,cc
  49
  50 # Extra options to supply to gtkdoc-fixref.
  51 FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
  52         --extra-dir=$(GST_PREFIX)/share/gtk-doc/html \
  53         --extra-dir=$(GSTPB_PREFIX)/share/gtk-doc/html
  54
  55 # Used for dependencies.
  56 HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.h
  57 CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c $(DOC_SOURCE_DIR)/*/*/*.cc $(DOC_SOURCE_DIR)/*/*/*.m
  58
  59 # this is a wingo addition
  60 # thomasvs: another nice wingo addition would be an explanation on why
  61 # this is useful ;)
  62
  63 SCANOBJ_DEPS =
  64
  65 # Header files to ignore when scanning.
  66 IGNORE_HFILES =
  67 IGNORE_CFILES =
  68
  69 # we add all .h files of elements that have signals/args we want
  70 # sadly this also pulls in the private methods - maybe we should
  71 # move those around in the source ?
  72 # also, we should add some stuff here conditionally based on whether
  73 # or not the plugin will actually build
  74 # but I'm not sure about that - it might be this Just Works given that
  75 # the registry won't have the element
  76
  77 EXTRA_HFILES = \
  78         $(top_srcdir)/ext/aalib/gstaasink.h \
  79         $(top_srcdir)/ext/annodex/gstcmmldec.h \
  80         $(top_srcdir)/ext/annodex/gstcmmlenc.h \
  81         $(top_srcdir)/ext/cairo/gsttextoverlay.h \
  82         $(top_srcdir)/ext/cairo/gsttimeoverlay.h \
  83         $(top_srcdir)/ext/cairo/gstcairorender.h \
  84         $(top_srcdir)/ext/cairo/gstcairooverlay.h \
  85         $(top_srcdir)/ext/dv/gstdvdec.h \
  86         $(top_srcdir)/ext/dv/gstdvdemux.h \
  87         $(top_srcdir)/ext/esd/esdsink.h \
  88         $(top_srcdir)/ext/flac/gstflacdec.h \
  89         $(top_srcdir)/ext/flac/gstflacenc.h \
  90         $(top_srcdir)/ext/flac/gstflactag.h \
  91         $(top_srcdir)/ext/gconf/gstgconfaudiosrc.h \
  92         $(top_srcdir)/ext/gconf/gstgconfaudiosink.h \
  93         $(top_srcdir)/ext/gconf/gstgconfvideosrc.h \
  94         $(top_srcdir)/ext/gconf/gstgconfvideosink.h \
  95         $(top_srcdir)/ext/gdk_pixbuf/gstgdkpixbufsink.h \
  96         $(top_srcdir)/ext/hal/gsthalaudiosink.h \
  97         $(top_srcdir)/ext/hal/gsthalaudiosrc.h \
  98         $(top_srcdir)/ext/jack/gstjackaudiosrc.h \
  99         $(top_srcdir)/ext/jack/gstjackaudiosink.h \
 100         $(top_srcdir)/ext/jpeg/gstjpegdec.h \
 101         $(top_srcdir)/ext/jpeg/gstjpegenc.h \
 102         $(top_srcdir)/ext/jpeg/gstsmokedec.h \
 103         $(top_srcdir)/ext/jpeg/gstsmokeenc.h \
 104         $(top_srcdir)/ext/libcaca/gstcacasink.h \
 105         $(top_srcdir)/ext/libpng/gstpngdec.h \
 106         $(top_srcdir)/ext/libpng/gstpngenc.h \
 107         $(top_srcdir)/ext/raw1394/gstdv1394src.h \
 108         $(top_srcdir)/ext/raw1394/gsthdv1394src.h \
 109         $(top_srcdir)/ext/soup/gstsouphttpsrc.h \
 110         $(top_srcdir)/ext/taglib/gstapev2mux.h \
 111         $(top_srcdir)/ext/taglib/gstid3v2mux.h \
 112         $(top_srcdir)/ext/pulse/pulsesink.h \
 113         $(top_srcdir)/ext/pulse/pulsesrc.h \
 114         $(top_srcdir)/ext/pulse/pulsemixer.h \
 115         $(top_srcdir)/ext/speex/gstspeexenc.h \
 116         $(top_srcdir)/ext/speex/gstspeexdec.h \
 117         $(top_srcdir)/ext/wavpack/gstwavpackdec.h \
 118         $(top_srcdir)/ext/wavpack/gstwavpackenc.h \
 119         $(top_srcdir)/ext/wavpack/gstwavpackparse.h \
 120         $(top_srcdir)/gst/alpha/gstalpha.h \
 121         $(top_srcdir)/gst/alpha/gstalphacolor.h \
 122         $(top_srcdir)/gst/apetag/gstapedemux.h \
 123         $(top_srcdir)/gst/audiofx/audioamplify.h \
 124         $(top_srcdir)/gst/audiofx/audioecho.h \
 125         $(top_srcdir)/gst/audiofx/audiodynamic.h \
 126         $(top_srcdir)/gst/audiofx/audioinvert.h \
 127         $(top_srcdir)/gst/audiofx/audiokaraoke.h \
 128         $(top_srcdir)/gst/audiofx/audiopanorama.h \
 129         $(top_srcdir)/gst/audiofx/audiocheblimit.h \
 130         $(top_srcdir)/gst/audiofx/audiochebband.h \
 131         $(top_srcdir)/gst/audiofx/audioiirfilter.h \
 132         $(top_srcdir)/gst/audiofx/audiowsincband.h \
 133         $(top_srcdir)/gst/audiofx/audiowsinclimit.h \
 134         $(top_srcdir)/gst/audiofx/audiofirfilter.h \
 135         $(top_srcdir)/gst/audioparsers/gstaacparse.h \
 136         $(top_srcdir)/gst/audioparsers/gstac3parse.h \
 137         $(top_srcdir)/gst/audioparsers/gstamrparse.h \
 138         $(top_srcdir)/gst/audioparsers/gstflacparse.h \
 139         $(top_srcdir)/gst/audioparsers/gstdcaparse.h \
 140         $(top_srcdir)/gst/audioparsers/gstmpegaudioparse.h \
 141         $(top_srcdir)/gst/auparse/gstauparse.h \
 142         $(top_srcdir)/gst/autodetect/gstautoaudiosink.h \
 143         $(top_srcdir)/gst/autodetect/gstautoaudiosrc.h \
 144         $(top_srcdir)/gst/autodetect/gstautovideosink.h \
 145         $(top_srcdir)/gst/autodetect/gstautovideosrc.h \
 146         $(top_srcdir)/gst/avi/gstavidemux.h \
 147         $(top_srcdir)/gst/avi/gstavimux.h \
 148         $(top_srcdir)/gst/avi/gstavisubtitle.h \
 149         $(top_srcdir)/gst/cutter/gstcutter.h \
 150         $(top_srcdir)/gst/debugutils/gstcapssetter.h \
 151         $(top_srcdir)/gst/debugutils/gsttaginject.h \
 152         $(top_srcdir)/gst/debugutils/progressreport.h \
 153         $(top_srcdir)/gst/deinterlace/gstdeinterlace.h \
 154         $(top_srcdir)/gst/effectv/gstaging.h \
 155         $(top_srcdir)/gst/effectv/gstdice.h \
 156         $(top_srcdir)/gst/effectv/gstedge.h \
 157         $(top_srcdir)/gst/effectv/gstquark.h \
 158         $(top_srcdir)/gst/effectv/gstrev.h \
 159         $(top_srcdir)/gst/effectv/gstshagadelic.h \
 160         $(top_srcdir)/gst/effectv/gstvertigo.h \
 161         $(top_srcdir)/gst/effectv/gstwarp.h \
 162         $(top_srcdir)/gst/effectv/gststreak.h \
 163         $(top_srcdir)/gst/effectv/gstripple.h \
 164         $(top_srcdir)/gst/effectv/gstop.h \
 165         $(top_srcdir)/gst/effectv/gstradioac.h \
 166         $(top_srcdir)/gst/equalizer/gstiirequalizer.h \
 167         $(top_srcdir)/gst/equalizer/gstiirequalizer3bands.h \
 168         $(top_srcdir)/gst/equalizer/gstiirequalizer10bands.h \
 169         $(top_srcdir)/gst/equalizer/gstiirequalizernbands.h \
 170         $(top_srcdir)/gst/flv/gstflvdemux.h \
 171         $(top_srcdir)/gst/flv/gstflvmux.h \
 172         $(top_srcdir)/gst/flx/gstflxdec.h \
 173         $(top_srcdir)/gst/goom/gstgoom.h \
 174         $(top_srcdir)/gst/goom2k1/gstgoom.h \
 175         $(top_srcdir)/gst/law/alaw-decode.h \
 176         $(top_srcdir)/gst/law/alaw-encode.h \
 177         $(top_srcdir)/gst/law/mulaw-decode.h \
 178         $(top_srcdir)/gst/law/mulaw-encode.h \
 179         $(top_srcdir)/gst/icydemux/gsticydemux.h \
 180         $(top_srcdir)/gst/id3demux/gstid3demux.h \
 181         $(top_srcdir)/gst/imagefreeze/gstimagefreeze.h \
 182         $(top_srcdir)/gst/interleave/deinterleave.h \
 183         $(top_srcdir)/gst/interleave/interleave.h \
 184         $(top_srcdir)/gst/level/gstlevel.h \
 185         $(top_srcdir)/gst/matroska/matroska-demux.h \
 186         $(top_srcdir)/gst/matroska/matroska-mux.h \
 187         $(top_srcdir)/gst/matroska/webm-mux.h \
 188         $(top_srcdir)/gst/monoscope/gstmonoscope.h \
 189         $(top_srcdir)/gst/multifile/gstmultifilesink.h \
 190         $(top_srcdir)/gst/multifile/gstmultifilesrc.h \
 191         $(top_srcdir)/gst/multipart/multipartdemux.h \
 192         $(top_srcdir)/gst/multipart/multipartmux.h \
 193         $(top_srcdir)/gst/isomp4/qtdemux.h \
 194         $(top_srcdir)/gst/isomp4/gstqtmux.h \
 195         $(top_srcdir)/gst/isomp4/gstqtmux-doc.h \
 196         $(top_srcdir)/gst/replaygain/gstrganalysis.h \
 197         $(top_srcdir)/gst/replaygain/gstrglimiter.h \
 198         $(top_srcdir)/gst/replaygain/gstrgvolume.h \
 199         $(top_srcdir)/gst/rtp/gstrtpj2kpay.h \
 200         $(top_srcdir)/gst/rtp/gstrtpjpegpay.h \
 201         $(top_srcdir)/gst/rtpmanager/gstrtpbin.h \
 202         $(top_srcdir)/gst/rtpmanager/gstrtpjitterbuffer.h \
 203         $(top_srcdir)/gst/rtpmanager/gstrtpptdemux.h \
 204         $(top_srcdir)/gst/rtpmanager/gstrtpsession.h \
 205         $(top_srcdir)/gst/rtpmanager/gstrtpssrcdemux.h \
 206         $(top_srcdir)/gst/rtsp/gstrtpdec.h \
 207         $(top_srcdir)/gst/rtsp/gstrtspsrc.h \
 208         $(top_srcdir)/gst/shapewipe/gstshapewipe.h \
 209         $(top_srcdir)/gst/smpte/gstsmpte.h \
 210         $(top_srcdir)/gst/smpte/gstsmptealpha.h \
 211         $(top_srcdir)/gst/spectrum/gstspectrum.h \
 212         $(top_srcdir)/gst/udp/gstmultiudpsink.h \
 213         $(top_srcdir)/gst/udp/gstudpsrc.h \
 214         $(top_srcdir)/gst/udp/gstudpsink.h \
 215         $(top_srcdir)/gst/videobox/gstvideobox.h \
 216         $(top_srcdir)/gst/videocrop/gstvideocrop.h \
 217         $(top_srcdir)/gst/videocrop/gstaspectratiocrop.h \
 218         $(top_srcdir)/gst/videofilter/gstgamma.h \
 219         $(top_srcdir)/gst/videofilter/gstvideobalance.h \
 220         $(top_srcdir)/gst/videofilter/gstvideoflip.h \
 221         $(top_srcdir)/gst/videomixer/videomixer.h \
 222         $(top_srcdir)/gst/videomixer/videomixerpad.h \
 223         $(top_srcdir)/gst/videomixer/videomixer2.h \
 224         $(top_srcdir)/gst/videomixer/videomixer2pad.h \
 225         $(top_srcdir)/gst/wavenc/gstwavenc.h \
 226         $(top_srcdir)/gst/wavparse/gstwavparse.h \
 227         $(top_srcdir)/gst/y4m/gsty4mencode.h \
 228         $(top_srcdir)/sys/directsound/gstdirectsoundsink.h \
 229         $(top_srcdir)/sys/oss4/oss4-mixer.h \
 230         $(top_srcdir)/sys/oss4/oss4-sink.h \
 231         $(top_srcdir)/sys/oss4/oss4-source.h \
 232         $(top_srcdir)/sys/oss/gstossmixerelement.h \
 233         $(top_srcdir)/sys/oss/gstosssink.h \
 234         $(top_srcdir)/sys/oss/gstosssrc.h \
 235         $(top_srcdir)/sys/osxaudio/gstosxaudiosrc.h \
 236         $(top_srcdir)/sys/osxaudio/gstosxaudiosink.h \
 237         $(top_srcdir)/sys/osxvideo/osxvideosink.h \
 238         $(top_srcdir)/sys/v4l2/gstv4l2src.h \
 239         $(top_srcdir)/sys/v4l2/gstv4l2sink.h \
 240         $(top_srcdir)/sys/v4l2/gstv4l2radio.h \
 241         $(top_srcdir)/sys/waveform/gstwaveformsink.h \
 242         $(top_srcdir)/sys/ximage/gstximagesrc.h
 243
 244 # example code that needs to be converted to xml and placed in xml/
 245 EXAMPLE_CFILES = \
 246         $(top_srcdir)/tests/examples/level/level-example.c \
 247         $(top_srcdir)/tests/examples/spectrum/spectrum-example.c \
 248         $(top_srcdir)/tests/examples/audiofx/firfilter-example.c \
 249         $(top_srcdir)/tests/examples/audiofx/iirfilter-example.c
 250
 251 # Images to copy into HTML directory.
 252 HTML_IMAGES =
 253
 254 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
 255 content_files =
 256
 257 # Other files to distribute.
 258 extra_files =
 259
 260 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
 261 # contains GtkObjects/GObjects and you want to document signals and properties.
 262 GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir)
 263 GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS)
 264
 265 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
 266 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
 267
 268 # If you need to override some of the declarations, place them in this file
 269 # and uncomment this line.
 270 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
 271 DOC_OVERRIDES =
 272
 273 include $(top_srcdir)/common/gtk-doc-plugins.mak