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-base-libs 9 10# for upload-doc.mak 11DOC=gst-plugins-base-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" 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 39KISS_FFT_HFILES=$(wildcard $(top_srcdir)/gst-libs/gst/fft/*kiss_fft*.h) 40 41# Header files to ignore when scanning. 42# Note that you can't use glob, so all headers to be ignored must be specified 43IGNORE_HFILES = \ 44 $(top_srcdir)/gst-libs/gst/gettext.h \ 45 $(top_srcdir)/gst-libs/gst/gst-i18n-app.h \ 46 $(top_srcdir)/gst-libs/gst/gst-i18n-plugin.h \ 47 $(top_srcdir)/gst-libs/gst/glib-compat-private.h \ 48 $(top_srcdir)/gst-libs/gst/audio/gstaudioutilsprivate.h \ 49 $(top_srcdir)/gst-libs/gst/audio/gstaudiopack.h \ 50 $(top_srcdir)/gst-libs/gst/audio/gstaudiopack-dist.h \ 51 $(top_srcdir)/gst-libs/gst/audio/audio-resampler-private.h \ 52 $(top_srcdir)/gst-libs/gst/audio/audio-resampler-macros.h \ 53 $(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86.h \ 54 $(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86-sse.h \ 55 $(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86-sse2.h \ 56 $(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86-sse41.h \ 57 $(top_srcdir)/gst-libs/gst/audio/audio-resampler-neon.h \ 58 $(top_srcdir)/gst-libs/gst/gl/gstglcontext_private.h \ 59 $(top_srcdir)/gst-libs/gst/gl/gstglfeature_private.h \ 60 $(top_srcdir)/gst-libs/gst/gl/gstglfuncs.h \ 61 $(top_srcdir)/gst-libs/gst/gl/gstglsl_private.h \ 62 $(top_srcdir)/gst-libs/gst/gl/gstglutil_private.h \ 63 $(top_srcdir)/gst-libs/gst/gl/gstglwindow_private.h \ 64 $(top_srcdir)/gst-libs/gst/gl/android/gstglwindow_android_egl.h \ 65 $(top_srcdir)/gst-libs/gst/gl/cocoa/gstglcontext_cocoa.h \ 66 $(top_srcdir)/gst-libs/gst/gl/cocoa/gstglwindow_cocoa.h \ 67 $(top_srcdir)/gst-libs/gst/gl/cocoa/gstgl_cocoa_private.h \ 68 $(top_srcdir)/gst-libs/gst/gl/dispmanx/gstglwindow_dispmanx_egl.h \ 69 $(top_srcdir)/gst-libs/gst/gl/eagl/gstglwindow_eagl.h \ 70 $(top_srcdir)/gst-libs/gst/gl/eagl/gstglcontext_eagl.h \ 71 $(top_srcdir)/gst-libs/gst/gl/egl/gstglcontext_egl.h \ 72 $(top_srcdir)/gst-libs/gst/gl/gbm/gstgl_gbm_utils.h \ 73 $(top_srcdir)/gst-libs/gst/gl/gbm/gstgldisplay_gbm.h \ 74 $(top_srcdir)/gst-libs/gst/gl/gbm/gstglwindow_gbm_egl.h \ 75 $(top_srcdir)/gst-libs/gst/gl/utils/opengl_versions.h \ 76 $(top_srcdir)/gst-libs/gst/gl/utils/gles_versions.h \ 77 $(top_srcdir)/gst-libs/gst/gl/viv-fb/gstgldisplay_viv_fb.h \ 78 $(top_srcdir)/gst-libs/gst/gl/viv-fb/gstglwindow_viv_fb_egl.h \ 79 $(top_srcdir)/gst-libs/gst/gl/wayland/gstglwindow_wayland_egl.h \ 80 $(top_srcdir)/gst-libs/gst/gl/wayland/wayland_event_source.h \ 81 $(top_srcdir)/gst-libs/gst/gl/win32/gstglcontext_wgl.h \ 82 $(top_srcdir)/gst-libs/gst/gl/win32/gstglwindow_win32.h \ 83 $(top_srcdir)/gst-libs/gst/gl/win32/win32_message_source.h \ 84 $(top_srcdir)/gst-libs/gst/gl/x11/gstglwindow_x11.h \ 85 $(top_srcdir)/gst-libs/gst/gl/x11/gstglcontext_glx.h \ 86 $(top_srcdir)/gst-libs/gst/gl/x11/xcb_event_source.h \ 87 $(KISS_FFT_HFILES) \ 88 $(top_srcdir)/gst-libs/gst/pbutils/pbutils-private.h \ 89 $(top_srcdir)/gst-libs/gst/tag/gsttageditingprivate.h \ 90 $(top_srcdir)/gst-libs/gst/tag/id3v2.h \ 91 $(top_srcdir)/gst-libs/gst/video/gstvideoutilsprivate.h \ 92 $(top_srcdir)/gst-libs/gst/video/video-orc.h \ 93 $(top_srcdir)/gst-libs/gst/video/video-orc-dist.h 94 95 96# Images to copy into HTML directory. 97HTML_IMAGES = 98 99# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). 100content_files = compiling.sgml 101 102# Other files to distribute. 103extra_files = 104 105# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib 106# contains GtkObjects/GObjects and you want to document signals and properties. 107GTKDOC_CFLAGS = $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS) $(GL_CFLAGS) 108GTKDOC_LIBS = \ 109 $(top_builddir)/gst-libs/gst/allocators/libgstallocators-@GST_API_VERSION@.la \ 110 $(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_API_VERSION@.la \ 111 $(top_builddir)/gst-libs/gst/fft/libgstfft-@GST_API_VERSION@.la \ 112 $(top_builddir)/gst-libs/gst/rtp/libgstrtp-@GST_API_VERSION@.la \ 113 $(top_builddir)/gst-libs/gst/rtsp/libgstrtsp-@GST_API_VERSION@.la \ 114 $(top_builddir)/gst-libs/gst/sdp/libgstsdp-@GST_API_VERSION@.la \ 115 $(top_builddir)/gst-libs/gst/tag/libgsttag-@GST_API_VERSION@.la \ 116 $(top_builddir)/gst-libs/gst/video/libgstvideo-@GST_API_VERSION@.la \ 117 $(top_builddir)/gst-libs/gst/app/libgstapp-@GST_API_VERSION@.la \ 118 $(top_builddir)/gst-libs/gst/pbutils/libgstpbutils-@GST_API_VERSION@.la \ 119 $(top_builddir)/gst-libs/gst/riff/libgstriff-@GST_API_VERSION@.la \ 120 $(top_builddir)/gst-libs/gst/gl/libgstgl-@GST_API_VERSION@.la \ 121 $(GST_BASE_LIBS) 122 123# If you need to override some of the declarations, place them in this file 124DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt 125 126include $(top_srcdir)/common/gtk-doc.mak 127