mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-09 10:59:39 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/docs/libs/Makefile.am

127 lines
5.7 KiB
Makefile
Raw Normal View History

Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
## Process this file with automake to produce Makefile.in
docs/libs/Makefile.am: set a magic variable to indicate we know the docs are incomplete Original commit message from CVS: * docs/libs/Makefile.am: set a magic variable to indicate we know the docs are incomplete
2006-05-31 14:17:30 +00:00
# FIXME: fix the docs then remove this variable
DOCS_ARE_INCOMPLETE_PLEASE_FIXME=yespleasedo
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
# The name of the module, e.g. 'glib'.
gst: Update versioning
2012-04-04 12:20:13 +00:00
#DOC_MODULE=gst-plugins-libs-@GST_API_VERSION@
add notes on pkg-config Original commit message from CVS: add notes on pkg-config
2005-06-30 14:42:38 +00:00
DOC_MODULE=gst-plugins-base-libs
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
docs: Update common. Use upload-doc.mak instead of upload.mak
2009-06-11 12:28:20 +00:00
# for upload-doc.mak
add notes on pkg-config Original commit message from CVS: add notes on pkg-config
2005-06-30 14:42:38 +00:00
DOC=gst-plugins-base-libs
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
FORMATS=html
html: html-build.stamp
docs: Update common. Use upload-doc.mak instead of upload.mak
2009-06-11 12:28:20 +00:00
include $(top_srcdir)/common/upload-doc.mak
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
# The top-level SGML file. Change it if you want.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
docs: cleanup makefiles Remove commented out parts that we don't need. Remove "the wingo addition" - no so useful after all. Narrow down file-globs for plugin docs.
2011-09-07 12:07:00 +00:00
# The directory containing the source code.
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
DOC_SOURCE_DIR=$(top_srcdir)/gst-libs/gst
# Extra options to supply to gtkdoc-scan.
docs: update api decorators to ignore
2018-03-13 11:56:59 +00:00
SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" \
--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"
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
# Extra options to supply to gtkdoc-mkdb.
docs/libs/Makefile.am: Remove cruft and do some cleanups. Original commit message from CVS: * docs/libs/Makefile.am: Remove cruft and do some cleanups. * docs/libs/gst-plugins-base-libs-docs.sgml: Prepare for comming gtkdoc features (rebase against online docs).
2007-08-10 17:35:52 +00:00
MKDB_OPTIONS=--sgml-mode --output-format=xml
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
# Extra options to supply to gtkdoc-fixref.
docs/: Simplify --extra-dir as gtkdoc scans recursively. Original commit message from CVS: * docs/libs/Makefile.am: * docs/plugins/Makefile.am: Simplify --extra-dir as gtkdoc scans recursively.
2007-07-05 08:43:30 +00:00
FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
--extra-dir=$(GST_PREFIX)/share/gtk-doc/html
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
# Used for dependencies.
docs: cleanup makefiles Remove commented out parts that we don't need. Remove "the wingo addition" - no so useful after all. Narrow down file-globs for plugin docs.
2011-09-07 12:07:00 +00:00
HFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.h
CFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.c
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
docs/libs: The big spring cleanup * Explicitely specify which headers aren't to be included in gtkdoc-scan This is essentially all the headers that are not installed and only for internal/local usage. This also includes the orc-generated headers. * Remove all symbols/sections that are no longer present (due to accurately scanning only the headers we need). * Add or expose sections which weren't previously exposed * Make sure the "unified" library headers (ex: gst/video/video.h) are used everywhere applicable. Only use the specific headers where applicable (such as the GL-implementation-specific objects) * Add all documentation which was not previously exposed in the right sections * Update 'types' file to get as many runtime information as possible This brings down the number of unused symbols to 15 (from over 300).
2018-04-02 06:45:04 +00:00
KISS_FFT_HFILES=$(wildcard $(top_srcdir)/gst-libs/gst/fft/*kiss_fft*.h)
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
# Header files to ignore when scanning.
docs/libs: The big spring cleanup * Explicitely specify which headers aren't to be included in gtkdoc-scan This is essentially all the headers that are not installed and only for internal/local usage. This also includes the orc-generated headers. * Remove all symbols/sections that are no longer present (due to accurately scanning only the headers we need). * Add or expose sections which weren't previously exposed * Make sure the "unified" library headers (ex: gst/video/video.h) are used everywhere applicable. Only use the specific headers where applicable (such as the GL-implementation-specific objects) * Add all documentation which was not previously exposed in the right sections * Update 'types' file to get as many runtime information as possible This brings down the number of unused symbols to 15 (from over 300).
2018-04-02 06:45:04 +00:00
# Note that you can't use glob, so all headers to be ignored must be specified
IGNORE_HFILES = \
$(top_srcdir)/gst-libs/gst/gettext.h \
$(top_srcdir)/gst-libs/gst/gst-i18n-app.h \
$(top_srcdir)/gst-libs/gst/gst-i18n-plugin.h \
$(top_srcdir)/gst-libs/gst/glib-compat-private.h \
$(top_srcdir)/gst-libs/gst/audio/gstaudioutilsprivate.h \
$(top_srcdir)/gst-libs/gst/audio/gstaudiopack.h \
$(top_srcdir)/gst-libs/gst/audio/gstaudiopack-dist.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-private.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-macros.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86-sse.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86-sse2.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86-sse41.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-neon.h \
docs: add moved gl lib to documentation
2017-12-15 00:40:25 +00:00
$(top_srcdir)/gst-libs/gst/gl/gstglcontext_private.h \
docs/libs: The big spring cleanup * Explicitely specify which headers aren't to be included in gtkdoc-scan This is essentially all the headers that are not installed and only for internal/local usage. This also includes the orc-generated headers. * Remove all symbols/sections that are no longer present (due to accurately scanning only the headers we need). * Add or expose sections which weren't previously exposed * Make sure the "unified" library headers (ex: gst/video/video.h) are used everywhere applicable. Only use the specific headers where applicable (such as the GL-implementation-specific objects) * Add all documentation which was not previously exposed in the right sections * Update 'types' file to get as many runtime information as possible This brings down the number of unused symbols to 15 (from over 300).
2018-04-02 06:45:04 +00:00
$(top_srcdir)/gst-libs/gst/gl/gstglfeature_private.h \
gl/build: don't pass OpenGL headers to GIR g-ir-scanner does not have a good enough C parser to parse the GL system headers
2018-09-03 06:20:33 +00:00
$(top_srcdir)/gst-libs/gst/gl/gstglfuncs.h \
docs/libs: The big spring cleanup * Explicitely specify which headers aren't to be included in gtkdoc-scan This is essentially all the headers that are not installed and only for internal/local usage. This also includes the orc-generated headers. * Remove all symbols/sections that are no longer present (due to accurately scanning only the headers we need). * Add or expose sections which weren't previously exposed * Make sure the "unified" library headers (ex: gst/video/video.h) are used everywhere applicable. Only use the specific headers where applicable (such as the GL-implementation-specific objects) * Add all documentation which was not previously exposed in the right sections * Update 'types' file to get as many runtime information as possible This brings down the number of unused symbols to 15 (from over 300).
2018-04-02 06:45:04 +00:00
$(top_srcdir)/gst-libs/gst/gl/gstglsl_private.h \
$(top_srcdir)/gst-libs/gst/gl/gstglutil_private.h \
$(top_srcdir)/gst-libs/gst/gl/gstglwindow_private.h \
$(top_srcdir)/gst-libs/gst/gl/android/gstglwindow_android_egl.h \
$(top_srcdir)/gst-libs/gst/gl/cocoa/gstglcontext_cocoa.h \
$(top_srcdir)/gst-libs/gst/gl/cocoa/gstglwindow_cocoa.h \
$(top_srcdir)/gst-libs/gst/gl/cocoa/gstgl_cocoa_private.h \
$(top_srcdir)/gst-libs/gst/gl/dispmanx/gstglwindow_dispmanx_egl.h \
$(top_srcdir)/gst-libs/gst/gl/eagl/gstglwindow_eagl.h \
$(top_srcdir)/gst-libs/gst/gl/eagl/gstglcontext_eagl.h \
$(top_srcdir)/gst-libs/gst/gl/egl/gstglcontext_egl.h \
$(top_srcdir)/gst-libs/gst/gl/gbm/gstgl_gbm_utils.h \
$(top_srcdir)/gst-libs/gst/gl/gbm/gstgldisplay_gbm.h \
$(top_srcdir)/gst-libs/gst/gl/gbm/gstglwindow_gbm_egl.h \
$(top_srcdir)/gst-libs/gst/gl/utils/opengl_versions.h \
$(top_srcdir)/gst-libs/gst/gl/utils/gles_versions.h \
$(top_srcdir)/gst-libs/gst/gl/viv-fb/gstgldisplay_viv_fb.h \
$(top_srcdir)/gst-libs/gst/gl/viv-fb/gstglwindow_viv_fb_egl.h \
$(top_srcdir)/gst-libs/gst/gl/wayland/gstglwindow_wayland_egl.h \
$(top_srcdir)/gst-libs/gst/gl/wayland/wayland_event_source.h \
$(top_srcdir)/gst-libs/gst/gl/win32/gstglcontext_wgl.h \
$(top_srcdir)/gst-libs/gst/gl/win32/gstglwindow_win32.h \
$(top_srcdir)/gst-libs/gst/gl/win32/win32_message_source.h \
$(top_srcdir)/gst-libs/gst/gl/x11/gstglwindow_x11.h \
$(top_srcdir)/gst-libs/gst/gl/x11/gstglcontext_glx.h \
$(top_srcdir)/gst-libs/gst/gl/x11/xcb_event_source.h \
$(KISS_FFT_HFILES) \
$(top_srcdir)/gst-libs/gst/pbutils/pbutils-private.h \
$(top_srcdir)/gst-libs/gst/tag/gsttageditingprivate.h \
$(top_srcdir)/gst-libs/gst/tag/id3v2.h \
$(top_srcdir)/gst-libs/gst/video/gstvideoutilsprivate.h \
$(top_srcdir)/gst-libs/gst/video/video-orc.h \
$(top_srcdir)/gst-libs/gst/video/video-orc-dist.h
docs: some docs love
2011-09-05 20:40:05 +00:00
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
# Images to copy into HTML directory.
HTML_IMAGES =
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
add notes on pkg-config Original commit message from CVS: add notes on pkg-config
2005-06-30 14:42:38 +00:00
content_files = compiling.sgml
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
# Other files to distribute.
extra_files =
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
# contains GtkObjects/GObjects and you want to document signals and properties.
Remove -DGST_USE_UNSTABLE_API
2012-09-17 15:03:39 +00:00
GTKDOC_CFLAGS = $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS)
docs: cleanup makefiles Remove commented out parts that we don't need. Remove "the wingo addition" - no so useful after all. Narrow down file-globs for plugin docs.
2011-09-07 12:07:00 +00:00
GTKDOC_LIBS = \
allocators: Integrate into the documentation
2013-02-19 09:05:17 +00:00
$(top_builddir)/gst-libs/gst/allocators/libgstallocators-@GST_API_VERSION@.la \
gst: Update versioning
2012-04-04 12:20:13 +00:00
$(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/fft/libgstfft-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/rtp/libgstrtp-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/rtsp/libgstrtsp-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/sdp/libgstsdp-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/tag/libgsttag-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/video/libgstvideo-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/app/libgstapp-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/pbutils/libgstpbutils-@GST_API_VERSION@.la \
docs: Add proper libraries to GST_LIBS instead (-base)
2012-08-06 13:28:06 +00:00
$(top_builddir)/gst-libs/gst/riff/libgstriff-@GST_API_VERSION@.la \
docs: add moved gl lib to documentation
2017-12-15 00:40:25 +00:00
$(top_builddir)/gst-libs/gst/gl/libgstgl-@GST_API_VERSION@.la \
docs: Add proper libraries to GST_LIBS instead (-base)
2012-08-06 13:28:06 +00:00
$(GST_BASE_LIBS)
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
# If you need to override some of the declarations, place them in this file
docs: activate overrides file to fix make distcheck
2011-09-06 18:13:30 +00:00
DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
Added boilerplate gtk-doc files for plugin-libs documentation. Original commit message from CVS: Added boilerplate gtk-doc files for plugin-libs documentation.
2004-12-20 16:29:06 +00:00
copy extra content files; make plugins-base use gtk-doc.mak Original commit message from CVS: copy extra content files; make plugins-base use gtk-doc.mak
2005-07-07 16:41:21 +00:00
include $(top_srcdir)/common/gtk-doc.mak
Reference in a new issue Copy permalink