blob: ef2d37f8e3e14c41a244492ab50feb8ddc8061c4 [file] [log] [blame]
Thibault Saunier4ca79462011-08-30 14:50:41 -03001## Process this file with automake to produce Makefile.in
2
3# FIXME: fix the docs then remove this variable
4DOCS_ARE_INCOMPLETE_PLEASE_FIXME=yespleasedo
5
6# The name of the module, e.g. 'glib'.
Sebastian Dröge1318a972012-04-04 14:41:22 +02007#DOC_MODULE=gst-plugins-libs-@GST_API_VERSION@
Thibault Saunier4ca79462011-08-30 14:50:41 -03008DOC_MODULE=gst-plugins-bad-libs
9
10# for upload-doc.mak
11DOC=gst-plugins-bad-libs
12FORMATS=html
13html: html-build.stamp
14include $(top_srcdir)/common/upload-doc.mak
15
Thibault Saunier4ca79462011-08-30 14:50:41 -030016# The top-level SGML file. Change it if you want.
17DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
18
Stefan Sauerdbcec902011-09-07 15:48:33 +020019# The directory containing the source code.
Thibault Saunier4ca79462011-08-30 14:50:41 -030020# gtk-doc will search all .c & .h files beneath here for inline comments
21# documenting functions and macros.
22DOC_SOURCE_DIR=$(top_srcdir)/gst-libs/gst
Thibault Saunier4ca79462011-08-30 14:50:41 -030023
24# Extra options to supply to gtkdoc-scan.
25SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
26
Thibault Saunier4ca79462011-08-30 14:50:41 -030027# Extra options to supply to gtkdoc-mkdb.
28MKDB_OPTIONS=--sgml-mode --output-format=xml
29
30# Extra options to supply to gtkdoc-fixref.
31FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
32 --extra-dir=$(GST_PREFIX)/share/gtk-doc/html
33
34# Used for dependencies.
Stefan Sauerdbcec902011-09-07 15:48:33 +020035HFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.h
36CFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.c
Thibault Saunier4ca79462011-08-30 14:50:41 -030037
38# Header files to ignore when scanning.
Sebastian Dröged16eb472015-12-22 14:44:28 +010039IGNORE_HFILES = \
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 \
Tim-Philipp Müller769a21d2017-12-11 12:59:09 +000043 $(top_srcdir)/gst-libs/gst/player/gstplayer-media-info-private.h
Thibault Saunier4ca79462011-08-30 14:50:41 -030044
45# Images to copy into HTML directory.
46HTML_IMAGES =
47
48# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
49content_files = compiling.sgml
50
51# Other files to distribute.
52extra_files =
53
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.
Edward Herveyf70a6232011-12-30 11:41:17 +010056GTKDOC_CFLAGS = -DGST_USE_UNSTABLE_API $(GST_PLUGINS_BAD_CFLAGS) $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS)
Stefan Sauerdbcec902011-09-07 15:48:33 +020057GTKDOC_LIBS = \
Tim-Philipp Müller7f0697c2016-11-30 09:35:27 +000058 $(top_builddir)/gst-libs/gst/audio/libgstbadaudio-@GST_API_VERSION@.la \
59 $(top_builddir)/gst-libs/gst/video/libgstbadvideo-@GST_API_VERSION@.la \
Sebastian Dröge1318a972012-04-04 14:41:22 +020060 $(top_builddir)/gst-libs/gst/codecparsers/libgstcodecparsers-@GST_API_VERSION@.la \
Stefan Sauer02c75e52015-06-07 16:28:43 +020061 $(top_builddir)/gst-libs/gst/insertbin/libgstinsertbin-@GST_API_VERSION@.la \
62 $(top_builddir)/gst-libs/gst/mpegts/libgstmpegts-@GST_API_VERSION@.la \
Sebastian Dröged16eb472015-12-22 14:44:28 +010063 $(top_builddir)/gst-libs/gst/player/libgstplayer-@GST_API_VERSION@.la \
Matthew Waters18942932017-01-31 20:56:59 +110064 $(top_builddir)/gst-libs/gst/webrtc/libgstwebrtc-@GST_API_VERSION@.la \
Edward Herveyf70a6232011-12-30 11:41:17 +010065 $(GST_BASE_LIBS)
Thibault Saunier4ca79462011-08-30 14:50:41 -030066
Thibault Saunier4ca79462011-08-30 14:50:41 -030067# If you need to override some of the declarations, place them in this file
68# and uncomment this line.
Tim-Philipp Müllera9709552011-12-11 16:07:44 +000069DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
Thibault Saunier4ca79462011-08-30 14:50:41 -030070
71include $(top_srcdir)/common/gtk-doc.mak
72