1 ## Process this file with automake to produce Makefile.in
3 # The name of the module, e.g. 'glib'.
4 #DOC_MODULE=gstreamer-libs-@GST_API_VERSION@
5 DOC_MODULE=gstreamer-libs
7 # don't want $(DOC_MODULE)-scan.c to be built with -Werror
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)/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 --ignore-files="$(IGNORE_HFILES)"
30 # Extra options to supply to gtkdoc-fixref.
31 FIXXREF_OPTIONS=--extra-dir=$(top_builddir)/docs/gst/html \
32 --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
33 --extra-dir=$(datadir)/gtk-doc/html
35 # Used for dependencies.
36 HFILE_GLOB=$(top_srcdir)/libs/gst/*/*.h
37 CFILE_GLOB=$(top_srcdir)/libs/gst/*/*.c
39 # Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj.
40 SCANOBJ_OPTIONS=--type-init-func="gst_init(&argc,&argv)"
42 # Header files to ignore when scanning.
44 check/libcheck internal-check.h \
45 gstinterpolationcontrolsourceprivate.h \
46 gstlfocontrolsourceprivate.h \
52 # Images to copy into HTML directory.
53 HTML_IMAGES = gdp-header.png
55 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
58 # Other files to distribute.
61 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
62 # contains GtkObjects/GObjects and you want to document signals and properties.
63 GTKDOC_CFLAGS = -I$(top_builddir) -I$(top_builddir)/libs $(GST_OBJ_CFLAGS)
65 $(top_builddir)/libs/gst/controller/libgstcontroller-@GST_API_VERSION@.la \
66 $(top_builddir)/libs/gst/base/libgstbase-@GST_API_VERSION@.la \
67 $(top_builddir)/libs/gst/net/libgstnet-@GST_API_VERSION@.la \
68 $(top_builddir)/libs/gst/check/libgstcheck-@GST_API_VERSION@.la \
71 GTKDOC_EXTRA_ENVIRONMENT= \
72 GST_PLUGIN_SCANNER_1_0=$(top_builddir)/libs/gst/helpers/gst-plugin-scanner
74 # If you need to override some of the declarations, place them in this file
75 # and uncomment this line.
76 DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
78 include $(top_srcdir)/common/gtk-doc.mak