1 GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
3 ## Process this file with automake to produce Makefile.in
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
13 html: html-build.stamp
14 include $(top_srcdir)/common/upload-doc.mak
16 # The top-level SGML file. Change it if you want.
17 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
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
24 # Extra options to supply to gtkdoc-scan.
27 # Extra options to supply to gtkdoc-mkdb.
28 MKDB_OPTIONS=--sgml-mode --source-suffixes=c,h,cc
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
35 # Used for dependencies.
37 $(top_srcdir)/gst/*/*.h $(top_srcdir)/ext/*/*.h $(top_srcdir)/sys/*/*.h
39 $(top_srcdir)/gst/*/*.c $(top_srcdir)/ext/*/*.c $(top_srcdir)/sys/*/*.c \
40 $(top_srcdir)/ext/*/*.cc $(top_srcdir)/sys/*/*.m
42 # Header files to ignore when scanning.
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
55 $(top_srcdir)/ext/aalib/gstaasink.h \
56 $(top_srcdir)/ext/annodex/gstcmmldec.h \
57 $(top_srcdir)/ext/annodex/gstcmmlenc.h \
58 $(top_srcdir)/ext/cairo/gsttextoverlay.h \
59 $(top_srcdir)/ext/cairo/gsttimeoverlay.h \
60 $(top_srcdir)/ext/cairo/gstcairorender.h \
61 $(top_srcdir)/ext/cairo/gstcairooverlay.h \
62 $(top_srcdir)/ext/dv/gstdvdec.h \
63 $(top_srcdir)/ext/dv/gstdvdemux.h \
64 $(top_srcdir)/ext/flac/gstflacdec.h \
65 $(top_srcdir)/ext/flac/gstflacenc.h \
66 $(top_srcdir)/ext/flac/gstflactag.h \
67 $(top_srcdir)/ext/gdk_pixbuf/gstgdkpixbufsink.h \
68 $(top_srcdir)/ext/jack/gstjackaudiosrc.h \
69 $(top_srcdir)/ext/jack/gstjackaudiosink.h \
70 $(top_srcdir)/ext/jpeg/gstjpegdec.h \
71 $(top_srcdir)/ext/jpeg/gstjpegenc.h \
72 $(top_srcdir)/ext/libcaca/gstcacasink.h \
73 $(top_srcdir)/ext/libpng/gstpngdec.h \
74 $(top_srcdir)/ext/libpng/gstpngenc.h \
75 $(top_srcdir)/ext/raw1394/gstdv1394src.h \
76 $(top_srcdir)/ext/raw1394/gsthdv1394src.h \
77 $(top_srcdir)/ext/soup/gstsouphttpsrc.h \
78 $(top_srcdir)/ext/taglib/gstapev2mux.h \
79 $(top_srcdir)/ext/taglib/gstid3v2mux.h \
80 $(top_srcdir)/ext/pulse/pulsesink.h \
81 $(top_srcdir)/ext/pulse/pulsesrc.h \
82 $(top_srcdir)/ext/pulse/pulsemixer.h \
83 $(top_srcdir)/ext/speex/gstspeexenc.h \
84 $(top_srcdir)/ext/speex/gstspeexdec.h \
85 $(top_srcdir)/ext/wavpack/gstwavpackdec.h \
86 $(top_srcdir)/ext/wavpack/gstwavpackenc.h \
87 $(top_srcdir)/ext/wavpack/gstwavpackparse.h \
88 $(top_srcdir)/gst/alpha/gstalpha.h \
89 $(top_srcdir)/gst/alpha/gstalphacolor.h \
90 $(top_srcdir)/gst/apetag/gstapedemux.h \
91 $(top_srcdir)/gst/audiofx/audioamplify.h \
92 $(top_srcdir)/gst/audiofx/audioecho.h \
93 $(top_srcdir)/gst/audiofx/audiodynamic.h \
94 $(top_srcdir)/gst/audiofx/audioinvert.h \
95 $(top_srcdir)/gst/audiofx/audiokaraoke.h \
96 $(top_srcdir)/gst/audiofx/audiopanorama.h \
97 $(top_srcdir)/gst/audiofx/audiocheblimit.h \
98 $(top_srcdir)/gst/audiofx/audiochebband.h \
99 $(top_srcdir)/gst/audiofx/audioiirfilter.h \
100 $(top_srcdir)/gst/audiofx/audiowsincband.h \
101 $(top_srcdir)/gst/audiofx/audiowsinclimit.h \
102 $(top_srcdir)/gst/audiofx/audiofirfilter.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/effectv/gstaging.h \
123 $(top_srcdir)/gst/effectv/gstdice.h \
124 $(top_srcdir)/gst/effectv/gstedge.h \
125 $(top_srcdir)/gst/effectv/gstquark.h \
126 $(top_srcdir)/gst/effectv/gstrev.h \
127 $(top_srcdir)/gst/effectv/gstshagadelic.h \
128 $(top_srcdir)/gst/effectv/gstvertigo.h \
129 $(top_srcdir)/gst/effectv/gstwarp.h \
130 $(top_srcdir)/gst/effectv/gststreak.h \
131 $(top_srcdir)/gst/effectv/gstripple.h \
132 $(top_srcdir)/gst/effectv/gstop.h \
133 $(top_srcdir)/gst/effectv/gstradioac.h \
134 $(top_srcdir)/gst/equalizer/gstiirequalizer.h \
135 $(top_srcdir)/gst/equalizer/gstiirequalizer3bands.h \
136 $(top_srcdir)/gst/equalizer/gstiirequalizer10bands.h \
137 $(top_srcdir)/gst/equalizer/gstiirequalizernbands.h \
138 $(top_srcdir)/gst/flv/gstflvdemux.h \
139 $(top_srcdir)/gst/flv/gstflvmux.h \
140 $(top_srcdir)/gst/flx/gstflxdec.h \
141 $(top_srcdir)/gst/goom/gstgoom.h \
142 $(top_srcdir)/gst/goom2k1/gstgoom.h \
143 $(top_srcdir)/gst/law/alaw-decode.h \
144 $(top_srcdir)/gst/law/alaw-encode.h \
145 $(top_srcdir)/gst/law/mulaw-decode.h \
146 $(top_srcdir)/gst/law/mulaw-encode.h \
147 $(top_srcdir)/gst/icydemux/gsticydemux.h \
148 $(top_srcdir)/gst/id3demux/gstid3demux.h \
149 $(top_srcdir)/gst/imagefreeze/gstimagefreeze.h \
150 $(top_srcdir)/gst/interleave/deinterleave.h \
151 $(top_srcdir)/gst/interleave/interleave.h \
152 $(top_srcdir)/gst/level/gstlevel.h \
153 $(top_srcdir)/gst/matroska/matroska-demux.h \
154 $(top_srcdir)/gst/matroska/matroska-mux.h \
155 $(top_srcdir)/gst/matroska/webm-mux.h \
156 $(top_srcdir)/gst/monoscope/gstmonoscope.h \
157 $(top_srcdir)/gst/multifile/gstmultifilesink.h \
158 $(top_srcdir)/gst/multifile/gstmultifilesrc.h \
159 $(top_srcdir)/gst/multifile/gstsplitfilesrc.h \
160 $(top_srcdir)/gst/multipart/multipartdemux.h \
161 $(top_srcdir)/gst/multipart/multipartmux.h \
162 $(top_srcdir)/gst/isomp4/qtdemux.h \
163 $(top_srcdir)/gst/isomp4/gstqtmux.h \
164 $(top_srcdir)/gst/isomp4/gstqtmux-doc.h \
165 $(top_srcdir)/gst/replaygain/gstrganalysis.h \
166 $(top_srcdir)/gst/replaygain/gstrglimiter.h \
167 $(top_srcdir)/gst/replaygain/gstrgvolume.h \
168 $(top_srcdir)/gst/rtp/gstrtpj2kpay.h \
169 $(top_srcdir)/gst/rtp/gstrtpjpegpay.h \
170 $(top_srcdir)/gst/rtpmanager/gstrtpbin.h \
171 $(top_srcdir)/gst/rtpmanager/gstrtpjitterbuffer.h \
172 $(top_srcdir)/gst/rtpmanager/gstrtpptdemux.h \
173 $(top_srcdir)/gst/rtpmanager/gstrtpsession.h \
174 $(top_srcdir)/gst/rtpmanager/gstrtpssrcdemux.h \
175 $(top_srcdir)/gst/rtsp/gstrtpdec.h \
176 $(top_srcdir)/gst/rtsp/gstrtspsrc.h \
177 $(top_srcdir)/gst/shapewipe/gstshapewipe.h \
178 $(top_srcdir)/gst/smpte/gstsmpte.h \
179 $(top_srcdir)/gst/smpte/gstsmptealpha.h \
180 $(top_srcdir)/gst/spectrum/gstspectrum.h \
181 $(top_srcdir)/gst/udp/gstmultiudpsink.h \
182 $(top_srcdir)/gst/udp/gstudpsrc.h \
183 $(top_srcdir)/gst/udp/gstudpsink.h \
184 $(top_srcdir)/gst/videobox/gstvideobox.h \
185 $(top_srcdir)/gst/videocrop/gstvideocrop.h \
186 $(top_srcdir)/gst/videocrop/gstaspectratiocrop.h \
187 $(top_srcdir)/gst/videofilter/gstgamma.h \
188 $(top_srcdir)/gst/videofilter/gstvideobalance.h \
189 $(top_srcdir)/gst/videofilter/gstvideoflip.h \
190 $(top_srcdir)/gst/videomixer/videomixer2.h \
191 $(top_srcdir)/gst/videomixer/videomixer2pad.h \
192 $(top_srcdir)/gst/wavenc/gstwavenc.h \
193 $(top_srcdir)/gst/wavparse/gstwavparse.h \
194 $(top_srcdir)/gst/y4m/gsty4mencode.h \
195 $(top_srcdir)/sys/directsound/gstdirectsoundsink.h \
196 $(top_srcdir)/sys/oss4/oss4-mixer.h \
197 $(top_srcdir)/sys/oss4/oss4-sink.h \
198 $(top_srcdir)/sys/oss4/oss4-source.h \
199 $(top_srcdir)/sys/oss/gstossmixerelement.h \
200 $(top_srcdir)/sys/oss/gstosssink.h \
201 $(top_srcdir)/sys/oss/gstosssrc.h \
202 $(top_srcdir)/sys/osxaudio/gstosxaudiosrc.h \
203 $(top_srcdir)/sys/osxaudio/gstosxaudiosink.h \
204 $(top_srcdir)/sys/osxvideo/osxvideosink.h \
205 $(top_srcdir)/sys/v4l2/gstv4l2src.h \
206 $(top_srcdir)/sys/v4l2/gstv4l2sink.h \
207 $(top_srcdir)/sys/v4l2/gstv4l2radio.h \
208 $(top_srcdir)/sys/waveform/gstwaveformsink.h \
209 $(top_srcdir)/sys/ximage/gstximagesrc.h
211 # example code that needs to be converted to xml and placed in xml/
213 $(top_srcdir)/tests/examples/level/level-example.c \
214 $(top_srcdir)/tests/examples/spectrum/spectrum-example.c \
215 $(top_srcdir)/tests/examples/audiofx/firfilter-example.c \
216 $(top_srcdir)/tests/examples/audiofx/iirfilter-example.c
218 # Images to copy into HTML directory.
221 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
224 # Other files to distribute.
227 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
228 # contains GtkObjects/GObjects and you want to document signals and properties.
229 GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir)
230 GTKDOC_LIBS = $(GST_BASE_LIBS)
232 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
233 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
235 # If you need to override some of the declarations, place them in this file
236 # and uncomment this line.
237 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
240 include $(top_srcdir)/common/gtk-doc-plugins.mak