docs/plugins/Makefile.am: Part of previous cdparanoiasrc docs fixes, forgot to commit.
[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.mak
11 DOC=$(MODULE)-plugins
12 FORMATS=html
13 html: html-build.stamp
14 include $(srcdir)/../upload.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 # FIXME get the location of the installed gstreamer docs
52 #FIXXREF_OPTIONS=--extra-dir=../gst/html
53
54 # Used for dependencies.
55 HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.h
56 CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c
57
58 # this is a wingo addition
59 # thomasvs: another nice wingo addition would be an explanation on why
60 # this is useful ;)
61
62 SCANOBJ_DEPS =
63
64 # Header files to ignore when scanning.
65 IGNORE_HFILES = avcodec.h gstffmpegcodecmap.h dsputil.h
66 IGNORE_CFILES = utils.c mem.c imgconvert.c
67
68 # we add all .h files of elements that have signals/args we want
69 # sadly this also pulls in the private methods - maybe we should
70 # move those around in the source ?
71 # also, we should add some stuff here conditionally based on whether
72 # or not the plugin will actually build
73 # but I'm not sure about that - it might be this Just Works given that
74 # the registry won't have the element
75
76 EXTRA_HFILES = \
77         $(top_srcdir)/ext/cdparanoia/gstcdparanoiasrc.h \
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/gnomevfs/gstgnomevfssink.h \
82         $(top_srcdir)/ext/gnomevfs/gstgnomevfssrc.h \
83         $(top_srcdir)/ext/pango/gstclockoverlay.h \
84         $(top_srcdir)/ext/pango/gsttextoverlay.h \
85         $(top_srcdir)/ext/pango/gsttextrender.h \
86         $(top_srcdir)/ext/pango/gsttimeoverlay.h \
87         $(top_srcdir)/ext/theora/gsttheoradec.h \
88         $(top_srcdir)/ext/theora/gsttheoraenc.h \
89         $(top_srcdir)/ext/vorbis/vorbisdec.h \
90         $(top_srcdir)/ext/vorbis/vorbisenc.h \
91         $(top_srcdir)/ext/vorbis/vorbisparse.h \
92         $(top_srcdir)/gst/audioconvert/gstaudioconvert.h \
93         $(top_srcdir)/gst/audioresample/gstaudioresample.h \
94         $(top_srcdir)/gst/audiotestsrc/gstaudiotestsrc.h \
95         $(top_srcdir)/gst/ffmpegcolorspace/gstffmpegcolorspace.h \
96         $(top_srcdir)/gst/tcp/gstmultifdsink.h \
97         $(top_srcdir)/gst/tcp/gsttcpserversink.h \
98         $(top_srcdir)/gst/videorate/gstvideorate.h \
99         $(top_srcdir)/gst/videoscale/gstvideoscale.h \
100         $(top_srcdir)/gst/videotestsrc/gstvideotestsrc.h \
101         $(top_srcdir)/gst/volume/gstvolume.h \
102         $(top_srcdir)/sys/ximage/ximagesink.h \
103         $(top_srcdir)/sys/xvimage/xvimagesink.h
104
105 # Images to copy into HTML directory.
106 HTML_IMAGES =
107
108 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
109 content_files =
110
111 # Other files to distribute.
112 extra_files =
113
114 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
115 # contains GtkObjects/GObjects and you want to document signals and properties.
116 GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir) -I$(top_builddir)/gst-libs
117 GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS)
118
119 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
120 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
121
122 # If you need to override some of the declarations, place them in this file
123 # and uncomment this line.
124 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
125 DOC_OVERRIDES =
126
127 include $(top_srcdir)/common/gtk-doc-plugins.mak