1## 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'. 7#DOC_MODULE=gst-plugins-libs-@GST_API_VERSION@ 8DOC_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 16# The top-level SGML file. Change it if you want. 17DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml 18 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. 22DOC_SOURCE_DIR=$(top_srcdir)/gst-libs/gst 23 24# Extra options to supply to gtkdoc-scan. 25SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" \ 26 --ignore-decorators="GST_API|GST_BASE_API|GST_CHECK_API|GST_CONTROLLER_API|GST_NET_API|GST_ALLOCATORS_API|GST_APP_API|GST_AUDIO_API|GST_FFT_API|GST_GL_API|GST_PBUTILS_API|GST_RIFF_API|GST_RTP_API|GST_RTSP_API|GST_SDP_API|GST_TAG_API|GST_VIDEO_API|GST_ADAPTIVE_DEMUX_API|GST_AUDIO_BAD_API|GST_BASE_CAMERA_BIN_SRC_API|GST_CODEC_PARSERS_API|GST_INSERT_BIN_API|GST_ISOFF_API|GST_PHOTOGRAPHY_API|GST_MPEGTS_API|GST_OPENCV_API|GST_PLAYER_API|GST_URI_DOWNLOADER_API|GST_VIDEO_BAD_API|GST_WAYLAND_API|GST_WEBRTC_API" 27 28# Extra options to supply to gtkdoc-mkdb. 29MKDB_OPTIONS=--sgml-mode --output-format=xml 30 31# Extra options to supply to gtkdoc-fixref. 32FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \ 33 --extra-dir=$(GST_PREFIX)/share/gtk-doc/html 34 35# Used for dependencies. 36HFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.h 37CFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.c 38 39# Header files to ignore when scanning. 40IGNORE_HFILES = \ 41 $(top_srcdir)/gst-libs/gst/mpegts/gstmpegts-private.h \ 42 $(top_srcdir)/gst-libs/gst/player/gstplayer-signal-dispatcher-private.h \ 43 $(top_srcdir)/gst-libs/gst/player/gstplayer-video-renderer-private.h \ 44 $(top_srcdir)/gst-libs/gst/player/gstplayer-media-info-private.h 45 46# Images to copy into HTML directory. 47HTML_IMAGES = 48 49# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). 50content_files = compiling.sgml 51 52# Other files to distribute. 53extra_files = 54 55# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib 56# contains GtkObjects/GObjects and you want to document signals and properties. 57GTKDOC_CFLAGS = -DGST_USE_UNSTABLE_API $(GST_PLUGINS_BAD_CFLAGS) $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS) 58GTKDOC_LIBS = \ 59 $(top_builddir)/gst-libs/gst/audio/libgstbadaudio-@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 \ 64 $(top_builddir)/gst-libs/gst/webrtc/libgstwebrtc-@GST_API_VERSION@.la \ 65 $(GST_BASE_LIBS) 66 67# If you need to override some of the declarations, place them in this file 68# and uncomment this line. 69DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt 70 71include $(top_srcdir)/common/gtk-doc.mak 72 73