1 ## Process this file with automake to produce Makefile.in
3 # FIXME: fix the docs then remove this variable
4 DOCS_ARE_INCOMPLETE_PLEASE_FIXME=yespleasedo
6 # The name of the module, e.g. 'glib'.
7 #DOC_MODULE=gst-plugins-libs-@GST_API_VERSION@
8 DOC_MODULE=gst-plugins-bad-libs
11 DOC=gst-plugins-bad-libs
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-libs/gst
24 # Extra options to supply to gtkdoc-scan.
25 SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
27 # Extra options to supply to gtkdoc-mkdb.
28 MKDB_OPTIONS=--sgml-mode --output-format=xml
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
34 # Used for dependencies.
35 HFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.h
36 CFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.c
38 # Header files to ignore when scanning.
40 $(top_srcdir)/gst-libs/gst/mpegts/gstmpegts-private.h \
41 $(top_srcdir)/gst-libs/gst/player/gstplayer-signal-dispatcher-private.h \
42 $(top_srcdir)/gst-libs/gst/player/gstplayer-video-renderer-private.h \
43 $(top_srcdir)/gst-libs/gst/player/gstplayer-media-info-private.h
45 # Images to copy into HTML directory.
48 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
49 content_files = compiling.sgml
51 # Other files to distribute.
54 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
55 # contains GtkObjects/GObjects and you want to document signals and properties.
56 GTKDOC_CFLAGS = -DGST_USE_UNSTABLE_API $(GST_PLUGINS_BAD_CFLAGS) $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS)
58 $(top_builddir)/gst-libs/gst/audio/libgstbadaudio-@GST_API_VERSION@.la \
59 $(top_builddir)/gst-libs/gst/video/libgstbadvideo-@GST_API_VERSION@.la \
60 $(top_builddir)/gst-libs/gst/codecparsers/libgstcodecparsers-@GST_API_VERSION@.la \
61 $(top_builddir)/gst-libs/gst/insertbin/libgstinsertbin-@GST_API_VERSION@.la \
62 $(top_builddir)/gst-libs/gst/mpegts/libgstmpegts-@GST_API_VERSION@.la \
63 $(top_builddir)/gst-libs/gst/player/libgstplayer-@GST_API_VERSION@.la \
66 # If you need to override some of the declarations, place them in this file
67 # and uncomment this line.
68 DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
70 include $(top_srcdir)/common/gtk-doc.mak