subtitleoverlay: Add to the docs
[platform/upstream/gstreamer.git] / 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-base
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
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=$(datadir)/gtk-doc/html
54
55 # Used for dependencies.
56 HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.h
57 CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c
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 = avcodec.h gstffmpegcodecmap.h dsputil.h arch.h speex_resampler.h speex_resampler_wrapper.h fixed_arm4.h fixed_arm5e.h fixed_bfin.h fixed_debug.h fixed_generic.h resample_sse.h
67 IGNORE_CFILES = utils.c mem.c imgconvert.c
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/alsa/gstalsamixerelement.h \
79         $(top_srcdir)/ext/alsa/gstalsasink.h \
80         $(top_srcdir)/ext/alsa/gstalsasrc.h \
81         $(top_srcdir)/ext/cdparanoia/gstcdparanoiasrc.h \
82         $(top_srcdir)/ext/gio/gstgiosink.h \
83         $(top_srcdir)/ext/gio/gstgiosrc.h \
84         $(top_srcdir)/ext/gio/gstgiostreamsink.h \
85         $(top_srcdir)/ext/gio/gstgiostreamsrc.h \
86         $(top_srcdir)/ext/gnomevfs/gstgnomevfssink.h \
87         $(top_srcdir)/ext/gnomevfs/gstgnomevfssrc.h \
88         $(top_srcdir)/ext/ogg/gstoggdemux.h \
89         $(top_srcdir)/ext/ogg/gstoggmux.h \
90         $(top_srcdir)/ext/pango/gstclockoverlay.h \
91         $(top_srcdir)/ext/pango/gsttextoverlay.h \
92         $(top_srcdir)/ext/pango/gsttextrender.h \
93         $(top_srcdir)/ext/pango/gsttimeoverlay.h \
94         $(top_srcdir)/ext/theora/gsttheoradec.h \
95         $(top_srcdir)/ext/theora/gsttheoraenc.h \
96         $(top_srcdir)/ext/theora/gsttheoraparse.h \
97         $(top_srcdir)/ext/vorbis/gstvorbisdec.h \
98         $(top_srcdir)/ext/vorbis/gstvorbisenc.h \
99         $(top_srcdir)/ext/vorbis/gstvorbisparse.h \
100         $(top_srcdir)/ext/vorbis/gstvorbistag.h \
101         $(top_srcdir)/gst/adder/gstadder.h \
102         $(top_srcdir)/gst/audioconvert/audioconvert.h \
103         $(top_srcdir)/gst/audioconvert/gstaudioconvert.h \
104         $(top_srcdir)/gst/audiotestsrc/gstaudiotestsrc.h \
105         $(top_srcdir)/gst/ffmpegcolorspace/gstffmpegcolorspace.h \
106         $(top_srcdir)/gst/gdp/gstgdpdepay.h \
107         $(top_srcdir)/gst/gdp/gstgdppay.h \
108         $(top_srcdir)/gst/playback/gstplay-enum.h \
109         $(top_srcdir)/gst/playback/gstsubtitleoverlay.h \
110         $(top_srcdir)/gst/audioresample/gstaudioresample.h \
111         $(top_srcdir)/gst/tcp/gstmultifdsink.h \
112         $(top_srcdir)/gst/tcp/gsttcpclientsrc.h \
113         $(top_srcdir)/gst/tcp/gsttcpclientsink.h \
114         $(top_srcdir)/gst/tcp/gsttcpserversrc.h \
115         $(top_srcdir)/gst/tcp/gsttcpserversink.h \
116         $(top_srcdir)/gst/tcp/gsttcp-enumtypes.h \
117         $(top_srcdir)/gst/tcp/gsttcp.h \
118         $(top_srcdir)/gst/videorate/gstvideorate.h \
119         $(top_srcdir)/gst/videoscale/gstvideoscale.h \
120         $(top_srcdir)/gst/videotestsrc/gstvideotestsrc.h \
121         $(top_srcdir)/gst/volume/gstvolume.h \
122         $(top_srcdir)/sys/ximage/ximagesink.h \
123         $(top_srcdir)/sys/xvimage/xvimagesink.h \
124         $(top_srcdir)/gst-libs/gst/app/gstappsrc.h \
125         $(top_srcdir)/gst-libs/gst/app/gstappsink.h
126
127 # Images to copy into HTML directory.
128 HTML_IMAGES =
129
130 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
131 content_files =
132
133 # Other files to distribute.
134 extra_files =
135
136 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
137 # contains GtkObjects/GObjects and you want to document signals and properties.
138 GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir) -I$(top_builddir)/gst-libs
139 GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS)
140
141 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
142 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
143
144 # If you need to override some of the declarations, place them in this file
145 # and uncomment this line.
146 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
147 DOC_OVERRIDES =
148
149 include $(top_srcdir)/common/gtk-doc-plugins.mak