1GST_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@ 7MODULE=gst-plugins-good 8DOC_MODULE=$(MODULE)-plugins 9 10# for upload-doc.mak 11DOC=$(MODULE)-plugins 12FORMATS=html 13html: html-build.stamp 14include $(top_srcdir)/common/upload-doc.mak 15 16# The top-level SGML file. Change it if you want. 17DOC_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. 22DOC_SOURCE_DIR = $(top_srcdir)/gst $(top_srcdir)/ext $(top_srcdir)/sys 23 24# Extra options to supply to gtkdoc-scan. 25SCAN_OPTIONS= 26 27# Extra options to supply to gtkdoc-mkdb. 28MKDB_OPTIONS=--sgml-mode --source-suffixes=c,h,cc 29 30# Extra options to supply to gtkdoc-fixref. 31FIXXREF_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. 36HFILE_GLOB= \ 37 $(top_srcdir)/gst/*/*.h $(top_srcdir)/ext/*/*.h $(top_srcdir)/sys/*/*.h 38CFILE_GLOB= \ 39 $(top_srcdir)/gst/*/*.c $(top_srcdir)/ext/*/*.c $(top_srcdir)/sys/*/*.c \ 40 $(top_srcdir)/ext/*/*.cc $(top_srcdir)/sys/*/*.m 41 42# Header files to ignore when scanning. 43IGNORE_HFILES = 44IGNORE_CFILES = 45 46# we add all .h files of elements that have signals/args we want 47# sadly this also pulls in the private methods - maybe we should 48# move those around in the source ? 49# also, we should add some stuff here conditionally based on whether 50# or not the plugin will actually build 51# but I'm not sure about that - it might be this Just Works given that 52# the registry won't have the element 53 54EXTRA_HFILES = \ 55 $(top_srcdir)/ext/aalib/gstaasink.h \ 56 $(top_srcdir)/ext/cairo/gstcairooverlay.h \ 57 $(top_srcdir)/ext/dv/gstdvdec.h \ 58 $(top_srcdir)/ext/dv/gstdvdemux.h \ 59 $(top_srcdir)/ext/flac/gstflacdec.h \ 60 $(top_srcdir)/ext/flac/gstflacenc.h \ 61 $(top_srcdir)/ext/flac/gstflactag.h \ 62 $(top_srcdir)/ext/gdk_pixbuf/gstgdkpixbufsink.h \ 63 $(top_srcdir)/ext/jack/gstjackaudiosrc.h \ 64 $(top_srcdir)/ext/jack/gstjackaudiosink.h \ 65 $(top_srcdir)/ext/jpeg/gstjpegdec.h \ 66 $(top_srcdir)/ext/jpeg/gstjpegenc.h \ 67 $(top_srcdir)/ext/lame/gstlamemp3enc.h \ 68 $(top_srcdir)/ext/libcaca/gstcacasink.h \ 69 $(top_srcdir)/ext/libpng/gstpngdec.h \ 70 $(top_srcdir)/ext/libpng/gstpngenc.h \ 71 $(top_srcdir)/ext/raw1394/gstdv1394src.h \ 72 $(top_srcdir)/ext/raw1394/gsthdv1394src.h \ 73 $(top_srcdir)/ext/shout2/gstshout2.h \ 74 $(top_srcdir)/ext/soup/gstsouphttpsrc.h \ 75 $(top_srcdir)/ext/taglib/gstapev2mux.h \ 76 $(top_srcdir)/ext/taglib/gstid3v2mux.h \ 77 $(top_srcdir)/ext/twolame/gsttwolamemp2enc.h \ 78 $(top_srcdir)/ext/pulse/pulsesink.h \ 79 $(top_srcdir)/ext/pulse/pulsesrc.h \ 80 $(top_srcdir)/ext/speex/gstspeexenc.h \ 81 $(top_srcdir)/ext/speex/gstspeexdec.h \ 82 $(top_srcdir)/ext/vpx/gstvp8dec.h \ 83 $(top_srcdir)/ext/vpx/gstvp8enc.h \ 84 $(top_srcdir)/ext/wavpack/gstwavpackdec.h \ 85 $(top_srcdir)/ext/wavpack/gstwavpackenc.h \ 86 $(top_srcdir)/gst/alpha/gstalpha.h \ 87 $(top_srcdir)/gst/alpha/gstalphacolor.h \ 88 $(top_srcdir)/gst/apetag/gstapedemux.h \ 89 $(top_srcdir)/gst/audiofx/audioamplify.h \ 90 $(top_srcdir)/gst/audiofx/audioecho.h \ 91 $(top_srcdir)/gst/audiofx/audiodynamic.h \ 92 $(top_srcdir)/gst/audiofx/audioinvert.h \ 93 $(top_srcdir)/gst/audiofx/audiokaraoke.h \ 94 $(top_srcdir)/gst/audiofx/audiopanorama.h \ 95 $(top_srcdir)/gst/audiofx/audiocheblimit.h \ 96 $(top_srcdir)/gst/audiofx/audiochebband.h \ 97 $(top_srcdir)/gst/audiofx/audioiirfilter.h \ 98 $(top_srcdir)/gst/audiofx/audiowsincband.h \ 99 $(top_srcdir)/gst/audiofx/audiowsinclimit.h \ 100 $(top_srcdir)/gst/audiofx/audiofirfilter.h \ 101 $(top_srcdir)/gst/audiofx/gstscaletempo.h \ 102 $(top_srcdir)/gst/audiofx/gststereo.h \ 103 $(top_srcdir)/gst/audioparsers/gstaacparse.h \ 104 $(top_srcdir)/gst/audioparsers/gstac3parse.h \ 105 $(top_srcdir)/gst/audioparsers/gstamrparse.h \ 106 $(top_srcdir)/gst/audioparsers/gstflacparse.h \ 107 $(top_srcdir)/gst/audioparsers/gstdcaparse.h \ 108 $(top_srcdir)/gst/audioparsers/gstmpegaudioparse.h \ 109 $(top_srcdir)/gst/auparse/gstauparse.h \ 110 $(top_srcdir)/gst/autodetect/gstautoaudiosink.h \ 111 $(top_srcdir)/gst/autodetect/gstautoaudiosrc.h \ 112 $(top_srcdir)/gst/autodetect/gstautovideosink.h \ 113 $(top_srcdir)/gst/autodetect/gstautovideosrc.h \ 114 $(top_srcdir)/gst/avi/gstavidemux.h \ 115 $(top_srcdir)/gst/avi/gstavimux.h \ 116 $(top_srcdir)/gst/avi/gstavisubtitle.h \ 117 $(top_srcdir)/gst/cutter/gstcutter.h \ 118 $(top_srcdir)/gst/debugutils/gstcapssetter.h \ 119 $(top_srcdir)/gst/debugutils/gsttaginject.h \ 120 $(top_srcdir)/gst/debugutils/progressreport.h \ 121 $(top_srcdir)/gst/deinterlace/gstdeinterlace.h \ 122 $(top_srcdir)/gst/dtmf/gstdtmfsrc.h \ 123 $(top_srcdir)/gst/dtmf/gstrtpdtmfsrc.h \ 124 $(top_srcdir)/gst/dtmf/gstrtpdtmfdepay.h \ 125 $(top_srcdir)/gst/effectv/gstaging.h \ 126 $(top_srcdir)/gst/effectv/gstdice.h \ 127 $(top_srcdir)/gst/effectv/gstedge.h \ 128 $(top_srcdir)/gst/effectv/gstquark.h \ 129 $(top_srcdir)/gst/effectv/gstrev.h \ 130 $(top_srcdir)/gst/effectv/gstshagadelic.h \ 131 $(top_srcdir)/gst/effectv/gstvertigo.h \ 132 $(top_srcdir)/gst/effectv/gstwarp.h \ 133 $(top_srcdir)/gst/effectv/gststreak.h \ 134 $(top_srcdir)/gst/effectv/gstripple.h \ 135 $(top_srcdir)/gst/effectv/gstop.h \ 136 $(top_srcdir)/gst/effectv/gstradioac.h \ 137 $(top_srcdir)/gst/equalizer/gstiirequalizer.h \ 138 $(top_srcdir)/gst/equalizer/gstiirequalizer3bands.h \ 139 $(top_srcdir)/gst/equalizer/gstiirequalizer10bands.h \ 140 $(top_srcdir)/gst/equalizer/gstiirequalizernbands.h \ 141 $(top_srcdir)/gst/flv/gstflvdemux.h \ 142 $(top_srcdir)/gst/flv/gstflvmux.h \ 143 $(top_srcdir)/gst/flx/gstflxdec.h \ 144 $(top_srcdir)/gst/goom/gstgoom.h \ 145 $(top_srcdir)/gst/goom2k1/gstgoom.h \ 146 $(top_srcdir)/gst/law/alaw-decode.h \ 147 $(top_srcdir)/gst/law/alaw-encode.h \ 148 $(top_srcdir)/gst/law/mulaw-decode.h \ 149 $(top_srcdir)/gst/law/mulaw-encode.h \ 150 $(top_srcdir)/gst/icydemux/gsticydemux.h \ 151 $(top_srcdir)/gst/id3demux/gstid3demux.h \ 152 $(top_srcdir)/gst/imagefreeze/gstimagefreeze.h \ 153 $(top_srcdir)/gst/interleave/deinterleave.h \ 154 $(top_srcdir)/gst/interleave/interleave.h \ 155 $(top_srcdir)/gst/level/gstlevel.h \ 156 $(top_srcdir)/gst/matroska/matroska-demux.h \ 157 $(top_srcdir)/gst/matroska/matroska-mux.h \ 158 $(top_srcdir)/gst/matroska/webm-mux.h \ 159 $(top_srcdir)/gst/monoscope/gstmonoscope.h \ 160 $(top_srcdir)/gst/multifile/gstmultifilesink.h \ 161 $(top_srcdir)/gst/multifile/gstmultifilesrc.h \ 162 $(top_srcdir)/gst/multifile/gstsplitfilesrc.h \ 163 $(top_srcdir)/gst/multifile/gstsplitmuxsrc.h \ 164 $(top_srcdir)/gst/multifile/gstsplitmuxsink.h \ 165 $(top_srcdir)/gst/multipart/multipartdemux.h \ 166 $(top_srcdir)/gst/multipart/multipartmux.h \ 167 $(top_srcdir)/gst/isomp4/qtdemux.h \ 168 $(top_srcdir)/gst/isomp4/gstqtmux.h \ 169 $(top_srcdir)/gst/isomp4/gstqtmux-doc.h \ 170 $(top_srcdir)/gst/replaygain/gstrganalysis.h \ 171 $(top_srcdir)/gst/replaygain/gstrglimiter.h \ 172 $(top_srcdir)/gst/replaygain/gstrgvolume.h \ 173 $(top_srcdir)/gst/rtp/gstrtpj2kpay.h \ 174 $(top_srcdir)/gst/rtp/gstrtpjpegpay.h \ 175 $(top_srcdir)/gst/rtpmanager/gstrtpbin.h \ 176 $(top_srcdir)/gst/rtpmanager/gstrtpjitterbuffer.h \ 177 $(top_srcdir)/gst/rtpmanager/gstrtpptdemux.h \ 178 $(top_srcdir)/gst/rtpmanager/gstrtpsession.h \ 179 $(top_srcdir)/gst/rtpmanager/gstrtpssrcdemux.h \ 180 $(top_srcdir)/gst/rtpmanager/gstrtpmux.h \ 181 $(top_srcdir)/gst/rtpmanager/gstrtpdtmfmux.h \ 182 $(top_srcdir)/gst/rtpmanager/gstrtprtxsend.h \ 183 $(top_srcdir)/gst/rtpmanager/gstrtprtxreceive.h \ 184 $(top_srcdir)/gst/rtsp/gstrtpdec.h \ 185 $(top_srcdir)/gst/rtsp/gstrtspsrc.h \ 186 $(top_srcdir)/gst/shapewipe/gstshapewipe.h \ 187 $(top_srcdir)/gst/smpte/gstsmpte.h \ 188 $(top_srcdir)/gst/smpte/gstsmptealpha.h \ 189 $(top_srcdir)/gst/spectrum/gstspectrum.h \ 190 $(top_srcdir)/gst/udp/gstmultiudpsink.h \ 191 $(top_srcdir)/gst/udp/gstudpsrc.h \ 192 $(top_srcdir)/gst/udp/gstudpsink.h \ 193 $(top_srcdir)/gst/videobox/gstvideobox.h \ 194 $(top_srcdir)/gst/videocrop/gstvideocrop.h \ 195 $(top_srcdir)/gst/videocrop/gstaspectratiocrop.h \ 196 $(top_srcdir)/gst/videofilter/gstgamma.h \ 197 $(top_srcdir)/gst/videofilter/gstvideobalance.h \ 198 $(top_srcdir)/gst/videofilter/gstvideoflip.h \ 199 $(top_srcdir)/gst/videomixer/videomixer2.h \ 200 $(top_srcdir)/gst/videomixer/videomixer2pad.h \ 201 $(top_srcdir)/gst/wavenc/gstwavenc.h \ 202 $(top_srcdir)/gst/wavparse/gstwavparse.h \ 203 $(top_srcdir)/gst/y4m/gsty4mencode.h \ 204 $(top_srcdir)/sys/directsound/gstdirectsoundsink.h \ 205 $(top_srcdir)/sys/oss4/oss4-sink.h \ 206 $(top_srcdir)/sys/oss4/oss4-source.h \ 207 $(top_srcdir)/sys/oss/gstosssink.h \ 208 $(top_srcdir)/sys/oss/gstosssrc.h \ 209 $(top_srcdir)/sys/osxaudio/gstosxaudiosrc.h \ 210 $(top_srcdir)/sys/osxaudio/gstosxaudiosink.h \ 211 $(top_srcdir)/sys/osxvideo/osxvideosink.h \ 212 $(top_srcdir)/sys/v4l2/gstv4l2src.h \ 213 $(top_srcdir)/sys/v4l2/gstv4l2sink.h \ 214 $(top_srcdir)/sys/v4l2/gstv4l2transform.h \ 215 $(top_srcdir)/sys/v4l2/gstv4l2videodec.h \ 216 $(top_srcdir)/sys/v4l2/gstv4l2radio.h \ 217 $(top_srcdir)/sys/waveform/gstwaveformsink.h \ 218 $(top_srcdir)/sys/ximage/gstximagesrc.h 219 220# example code that needs to be converted to xml and placed in xml/ 221EXAMPLE_CFILES = \ 222 $(top_srcdir)/tests/examples/level/level-example.c \ 223 $(top_srcdir)/tests/examples/spectrum/spectrum-example.c \ 224 $(top_srcdir)/tests/examples/audiofx/firfilter-example.c \ 225 $(top_srcdir)/tests/examples/audiofx/iirfilter-example.c 226 227# Images to copy into HTML directory. 228HTML_IMAGES = 229 230# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). 231content_files = 232 233# Other files to distribute. 234extra_files = 235 236# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib 237# contains GtkObjects/GObjects and you want to document signals and properties. 238GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir) 239GTKDOC_LIBS = $(GST_BASE_LIBS) 240 241# If you need to override some of the declarations, place them in this file 242# and uncomment this line. 243#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt 244DOC_OVERRIDES = 245 246include $(top_srcdir)/common/gtk-doc-plugins.mak 247