Blame docs/libs/Makefile.am

Packit a6ee4b
## Process this file with automake to produce Makefile.in
Packit a6ee4b
Packit a6ee4b
# The name of the module, e.g. 'glib'.
Packit a6ee4b
#DOC_MODULE=gstreamer-libs-@GST_API_VERSION@
Packit a6ee4b
DOC_MODULE=gstreamer-libs
Packit a6ee4b
Packit a6ee4b
# don't want $(DOC_MODULE)-scan.c to be built with -Werror
Packit a6ee4b
ERROR_CFLAGS=
Packit a6ee4b
Packit a6ee4b
# for upload-doc.mak
Packit a6ee4b
DOC=gstreamer-libs
Packit a6ee4b
FORMATS=html
Packit a6ee4b
html: html-build.stamp
Packit a6ee4b
include $(top_srcdir)/common/upload-doc.mak
Packit a6ee4b
Packit a6ee4b
# The top-level SGML file. Change it if you want.
Packit a6ee4b
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
Packit a6ee4b
Packit a6ee4b
# The directory containing the source code.
Packit a6ee4b
# gtk-doc will search all .c & .h files beneath here for inline comments
Packit a6ee4b
# documenting functions and macros.
Packit a6ee4b
DOC_SOURCE_DIR=$(top_srcdir)/libs/gst
Packit a6ee4b
Packit a6ee4b
# Extra options to supply to gtkdoc-scan.
Packit a6ee4b
SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" \
Packit a6ee4b
  --ignore-decorators="GST_API|GST_BASE_API|GST_CHECK_API|GST_CONTROLLER_API|GST_NET_API"
Packit a6ee4b
Packit a6ee4b
# Extra options to supply to gtkdoc-mkdb.
Packit a6ee4b
MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files="$(IGNORE_HFILES)"
Packit a6ee4b
Packit a6ee4b
# Extra options to supply to gtkdoc-fixref.
Packit a6ee4b
FIXXREF_OPTIONS=--extra-dir=$(top_builddir)/docs/gst/html \
Packit a6ee4b
	--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
Packit a6ee4b
	--extra-dir=$(datadir)/gtk-doc/html
Packit a6ee4b
Packit a6ee4b
# Used for dependencies.
Packit a6ee4b
HFILE_GLOB=$(top_srcdir)/libs/gst/*/*.h
Packit a6ee4b
CFILE_GLOB=$(top_srcdir)/libs/gst/*/*.c
Packit a6ee4b
Packit a6ee4b
# Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj.
Packit a6ee4b
SCANOBJ_OPTIONS=--type-init-func="gst_init(&argc,&argv)"
Packit a6ee4b
Packit a6ee4b
CHECK_HFILES=$(wildcard $(top_srcdir)/libs/gst/check/libcheck/*.h)
Packit a6ee4b
CHECK_HFILES+=$(wildcard $(top_srcdir)/libs/gst/check/libcheck/libcompat/*.h)
Packit a6ee4b
Packit a6ee4b
# Header files to ignore when scanning.
Packit a6ee4b
IGNORE_HFILES = \
Packit a6ee4b
	$(CHECK_HFILES) \
Packit a6ee4b
	check/libcheck internal-check.h \
Packit a6ee4b
	gstinterpolationcontrolsourceprivate.h \
Packit a6ee4b
	gstlfocontrolsourceprivate.h \
Packit a6ee4b
	gstgetbits_inl.h \
Packit a6ee4b
	gstindex.h \
Packit a6ee4b
	dp-private.h \
Packit a6ee4b
	gstntppacket.h
Packit a6ee4b
Packit a6ee4b
# Images to copy into HTML directory.
Packit a6ee4b
HTML_IMAGES = gdp-header.png
Packit a6ee4b
Packit a6ee4b
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
Packit a6ee4b
content_files =
Packit a6ee4b
Packit a6ee4b
# Other files to distribute.
Packit a6ee4b
extra_files =
Packit a6ee4b
Packit a6ee4b
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
Packit a6ee4b
# contains GtkObjects/GObjects and you want to document signals and properties.
Packit a6ee4b
GTKDOC_CFLAGS = -I$(top_builddir) -I$(top_builddir)/libs $(GST_OBJ_CFLAGS)
Packit a6ee4b
GTKDOC_LIBS = \
Packit a6ee4b
	$(top_builddir)/libs/gst/controller/libgstcontroller-@GST_API_VERSION@.la \
Packit a6ee4b
	$(top_builddir)/libs/gst/base/libgstbase-@GST_API_VERSION@.la \
Packit a6ee4b
	$(top_builddir)/libs/gst/net/libgstnet-@GST_API_VERSION@.la \
Packit a6ee4b
	$(top_builddir)/libs/gst/check/libgstcheck-@GST_API_VERSION@.la \
Packit a6ee4b
	$(GST_OBJ_LIBS)
Packit a6ee4b
Packit a6ee4b
GTKDOC_EXTRA_ENVIRONMENT= \
Packit a6ee4b
    GST_PLUGIN_SCANNER_1_0=$(top_builddir)/libs/gst/helpers/gst-plugin-scanner
Packit a6ee4b
Packit a6ee4b
# If you need to override some of the declarations, place them in this file
Packit a6ee4b
# and uncomment this line.
Packit a6ee4b
DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
Packit a6ee4b
Packit a6ee4b
include $(top_srcdir)/common/gtk-doc.mak