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 $(srcdir)/../upload.mak
18 ## $(DOC_MODULE).types \
19 # $(DOC_MODULE)-sections.txt \
20 # $(DOC_MODULE)-docs.sgml
22 # ugly hack to make -unused.sgml work
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
30 # these rules are added to create parallel docs using GST_MAJORMINOR
31 #$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs%
34 #CLEANFILES = $(basefiles)
36 # The top-level SGML file. Change it if you want.
37 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
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)
44 # Extra options to supply to gtkdoc-scan.
47 # Extra options to supply to gtkdoc-mkdb.
48 MKDB_OPTIONS=--sgml-mode --source-suffixes=c,h,cc
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
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
59 # this is a wingo addition
60 # thomasvs: another nice wingo addition would be an explanation on why
65 # Header files to ignore when scanning.
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
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/gsttimeoverlay.h \
82 $(top_srcdir)/ext/cdio/gstcdiocddasrc.h \
83 $(top_srcdir)/ext/dv/gstdvdec.h \
84 $(top_srcdir)/ext/dv/gstdvdemux.h \
85 $(top_srcdir)/ext/esd/esdsink.h \
86 $(top_srcdir)/ext/flac/gstflacdec.h \
87 $(top_srcdir)/ext/gdk_pixbuf/gstgdkpixbufsink.h \
88 $(top_srcdir)/ext/hal/gsthalaudiosink.h \
89 $(top_srcdir)/ext/hal/gsthalaudiosrc.h \
90 $(top_srcdir)/ext/jpeg/gstjpegdec.h \
91 $(top_srcdir)/ext/jpeg/gstjpegenc.h \
92 $(top_srcdir)/ext/jpeg/gstsmokedec.h \
93 $(top_srcdir)/ext/jpeg/gstsmokeenc.h \
94 $(top_srcdir)/ext/libcaca/gstcacasink.h \
95 $(top_srcdir)/ext/libpng/gstpngdec.h \
96 $(top_srcdir)/ext/libpng/gstpngenc.h \
97 $(top_srcdir)/ext/raw1394/gstdv1394src.h \
98 $(top_srcdir)/ext/soup/gstsouphttpsrc.h \
99 $(top_srcdir)/ext/taglib/gstapev2mux.h \
100 $(top_srcdir)/ext/taglib/gstid3v2mux.h \
101 $(top_srcdir)/ext/pulse/pulsesink.h \
102 $(top_srcdir)/ext/pulse/pulsesrc.h \
103 $(top_srcdir)/ext/pulse/pulsemixer.h \
104 $(top_srcdir)/gst/alpha/gstalphacolor.h \
105 $(top_srcdir)/gst/apetag/gstapedemux.h \
106 $(top_srcdir)/gst/audiofx/audioamplify.h \
107 $(top_srcdir)/gst/audiofx/audiodynamic.h \
108 $(top_srcdir)/gst/audiofx/audioinvert.h \
109 $(top_srcdir)/gst/audiofx/audiokaraoke.h \
110 $(top_srcdir)/gst/audiofx/audiopanorama.h \
111 $(top_srcdir)/gst/audiofx/audiocheblimit.h \
112 $(top_srcdir)/gst/audiofx/audiochebband.h \
113 $(top_srcdir)/gst/audiofx/audiowsincband.h \
114 $(top_srcdir)/gst/audiofx/audiowsinclimit.h \
115 $(top_srcdir)/gst/autodetect/gstautoaudiosink.h \
116 $(top_srcdir)/gst/autodetect/gstautovideosink.h \
117 $(top_srcdir)/gst/avi/gstavidemux.h \
118 $(top_srcdir)/gst/avi/gstavimux.h \
119 $(top_srcdir)/gst/avi/gstavisubtitle.h \
120 $(top_srcdir)/gst/debug/progressreport.h \
121 $(top_srcdir)/gst/equalizer/gstiirequalizer.h \
122 $(top_srcdir)/gst/equalizer/gstiirequalizer3bands.h \
123 $(top_srcdir)/gst/equalizer/gstiirequalizer10bands.h \
124 $(top_srcdir)/gst/equalizer/gstiirequalizernbands.h \
125 $(top_srcdir)/gst/goom/gstgoom.h \
126 $(top_srcdir)/gst/icydemux/gsticydemux.h \
127 $(top_srcdir)/gst/id3demux/gstid3demux.h \
128 $(top_srcdir)/gst/level/gstlevel.h \
129 $(top_srcdir)/gst/monoscope/gstmonoscope.h \
130 $(top_srcdir)/gst/multifile/gstmultifilesink.h \
131 $(top_srcdir)/gst/multifile/gstmultifilesrc.h \
132 $(top_srcdir)/gst/multipart/multipartdemux.h \
133 $(top_srcdir)/gst/multipart/multipartmux.h \
134 $(top_srcdir)/gst/qtdemux/qtdemux.h \
135 $(top_srcdir)/gst/rtsp/gstrtpdec.h \
136 $(top_srcdir)/gst/rtsp/gstrtspsrc.h \
137 $(top_srcdir)/gst/smpte/gstsmpte.h \
138 $(top_srcdir)/gst/smpte/gstsmptealpha.h \
139 $(top_srcdir)/gst/spectrum/gstspectrum.h \
140 $(top_srcdir)/gst/udp/gstmultiudpsink.h \
141 $(top_srcdir)/gst/udp/gstudpsrc.h \
142 $(top_srcdir)/gst/videocrop/gstvideocrop.h \
143 $(top_srcdir)/gst/videofilter/gstgamma.h \
144 $(top_srcdir)/gst/videofilter/gstvideobalance.h \
145 $(top_srcdir)/gst/videofilter/gstvideoflip.h \
146 $(top_srcdir)/gst/videomixer/videomixer.h \
147 $(top_srcdir)/gst/videomixer/videomixerpad.h \
148 $(top_srcdir)/sys/waveform/gstwaveformsink.h \
149 $(top_srcdir)/ext/wavpack/gstwavpackdec.h \
150 $(top_srcdir)/ext/wavpack/gstwavpackenc.h \
151 $(top_srcdir)/ext/wavpack/gstwavpackparse.h \
152 $(top_srcdir)/gst/wavparse/gstwavparse.h \
153 $(top_srcdir)/sys/directdraw/gstdirectdrawsink.h \
154 $(top_srcdir)/sys/directsound/gstdirectsoundsink.h \
155 $(top_srcdir)/sys/oss/gstossmixerelement.h \
156 $(top_srcdir)/sys/oss/gstosssink.h \
157 $(top_srcdir)/sys/oss/gstosssrc.h \
158 $(top_srcdir)/sys/osxaudio/gstosxaudiosrc.h \
159 $(top_srcdir)/sys/osxaudio/gstosxaudiosink.h \
160 $(top_srcdir)/sys/osxvideo/osxvideosink.h \
161 $(top_srcdir)/sys/v4l2/gstv4l2src.h \
162 $(top_srcdir)/sys/ximage/gstximagesrc.h
165 # example code that needs to be converted to xml and placed in xml/
167 $(top_srcdir)/tests/examples/level/level-example.c \
168 $(top_srcdir)/tests/examples/spectrum/spectrum-example.c
170 # Images to copy into HTML directory.
173 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
176 # Other files to distribute.
179 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
180 # contains GtkObjects/GObjects and you want to document signals and properties.
181 GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir)
182 GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS)
184 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
185 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
187 # If you need to override some of the declarations, place them in this file
188 # and uncomment this line.
189 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
192 include $(top_srcdir)/common/gtk-doc-plugins.mak