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

78 lines
2.5 KiB
Makefile
Raw Normal View History

Documentation updates documented the libraries Original commit message from CVS: Documentation updates documented the libraries
2000-10-22 16:27:21 +00:00
## Process this file with automake to produce Makefile.in
converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +00:00
# The name of the module, e.g. 'glib'.
gst: Change versioning Remove GST_MAJORMINOR and replace it by GST_API_VERSION Also set GST_VERSION_{MAJOR,MINOR,MICRO,NANO} explicitely now. All versions are at 1.0.0 now for the release soon but API/ABI can still change until the 1.0.0 release. Next release versions until 1.0.0 will be 0.10.9X and these will be release candidates. GST_VERSION_* will nonetheless stay at 1.0.0.0.
2012-04-04 11:13:52 +00:00
#DOC_MODULE=gstreamer-libs-@GST_API_VERSION@
Documentation updates documented the libraries Original commit message from CVS: Documentation updates documented the libraries
2000-10-22 16:27:21 +00:00
DOC_MODULE=gstreamer-libs
docs: don't use ERROR_CFLAGS when building $docmodule-scan.c We don't want to use -Wall -Werror and friends when building the gtk-doc-generated $docmodule-scan.c, since we can't easily fix stuff if a certain gtk-doc/compiler combination breaks the build. Fixes build on ubuntu intrepid.
2009-01-27 17:53:01 +00:00
# don't want $(DOC_MODULE)-scan.c to be built with -Werror
ERROR_CFLAGS=
docs: Bump common, fix the upload logic inclusion Update the common submodule, and fix the docs upload rules to include the right makefile snippet from common.
2009-06-11 12:16:29 +00:00
# for upload-doc.mak
make upload work for both gtk-doc and docbook docs Original commit message from CVS: make upload work for both gtk-doc and docbook docs
2004-01-28 12:16:51 +00:00
DOC=gstreamer-libs
FORMATS=html
html: html-build.stamp
docs: Bump common, fix the upload logic inclusion Update the common submodule, and fix the docs upload rules to include the right makefile snippet from common.
2009-06-11 12:16:29 +00:00
include $(top_srcdir)/common/upload-doc.mak
make upload work for both gtk-doc and docbook docs Original commit message from CVS: make upload work for both gtk-doc and docbook docs
2004-01-28 12:16:51 +00:00
converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +00:00
# The top-level SGML file. Change it if you want.
Documentation updates documented the libraries Original commit message from CVS: Documentation updates documented the libraries
2000-10-22 16:27:21 +00:00
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:05:03 +00:00
# The directory containing the source code.
converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +00:00
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting functions and macros.
DOC_SOURCE_DIR=$(top_srcdir)/libs/gst
# Extra options to supply to gtkdoc-scan.
added params for deprecation guards documented some more enums Original commit message from CVS: added params for deprecation guards documented some more enums
2005-01-21 17:52:50 +00:00
SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +00:00
# Extra options to supply to gtkdoc-mkdb.
docs: ignore libcheck headers that use doxygen comments
2014-12-29 10:54:00 +00:00
MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files="$(IGNORE_HFILES)"
converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +00:00
# Extra options to supply to gtkdoc-fixref.
docs: do xrefs for non installed books too Get the xrefs from the builddir for the books in the same packages. This fixes the cross references if one does not have the docs already installed.
2011-03-23 15:13:58 +00:00
FIXXREF_OPTIONS=--extra-dir=$(top_builddir)/docs/gst/html \
--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
docs/: Simplity --extra-dir as gtkdoc scans recursively. Original commit message from CVS: * docs/gst/Makefile.am: * docs/libs/Makefile.am: * docs/plugins/Makefile.am: Simplity --extra-dir as gtkdoc scans recursively.
2007-07-05 08:42:42 +00:00
--extra-dir=$(datadir)/gtk-doc/html
converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +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:05:03 +00:00
HFILE_GLOB=$(top_srcdir)/libs/gst/*/*.h
CFILE_GLOB=$(top_srcdir)/libs/gst/*/*.c
added controller code removed dparam pc files Original commit message from CVS: added controller code removed dparam pc files
2005-08-02 21:35:34 +00:00
# Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj.
g_type_init() is no longer required and deprecated in glib >= 2.35.0 https://bugzilla.gnome.org/show_bug.cgi?id=686456
2012-10-20 11:54:06 +00:00
SCANOBJ_OPTIONS=--type-init-func="gst_init(&argc,&argv)"
converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +00:00
# Header files to ignore when scanning.
various doc and style fixes, adding bytestream Original commit message from CVS: various doc and style fixes, adding bytestream
2004-07-28 14:39:44 +00:00
IGNORE_HFILES = \
docs: ignore libcheck headers that use doxygen comments
2014-12-29 10:54:00 +00:00
check/libcheck check/internal-check.h \
docs/libs/: Ignore private controller headers for docs. Original commit message from CVS: * docs/libs/Makefile.am: * docs/libs/gstreamer-libs-sections.txt: Ignore private controller headers for docs.
2008-05-03 16:52:16 +00:00
gstinterpolationcontrolsourceprivate.h \
gstlfocontrolsourceprivate.h \
various doc and style fixes, adding bytestream Original commit message from CVS: various doc and style fixes, adding bytestream
2004-07-28 14:39:44 +00:00
gstgetbits_inl.h \
docs: add missing docs, fixing doc errors * add many missing declarations to sections * GstController has been removed, update docs * skip GstIndex when generating documentation * rephrase so gtkdoc doesn't imagine return value * add missing argument description for gst_context_new() * document GstOutputSelectorPadNegotiationMode and move to header-file https://bugzilla.gnome.org/show_bug.cgi?id=719614
2013-11-30 11:15:37 +00:00
gstindex.h \
various doc and style fixes, adding bytestream Original commit message from CVS: various doc and style fixes, adding bytestream
2004-07-28 14:39:44 +00:00
dp-private.h
converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +00:00
# Images to copy into HTML directory.
docs/: add a gdp image Original commit message from CVS: * docs/README: * docs/images/gdp-header.svg: add a gdp image * docs/libs/Makefile.am: * docs/libs/gdp-header.png: * libs/gst/dataprotocol/dataprotocol.c: add it to the API docs * docs/manual/intro-motivation.xml: fix typo
2006-06-13 19:24:34 +00:00
HTML_IMAGES = gdp-header.png
converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +00:00
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
content_files =
# 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.
docs/libs/Makefile.am: Include our build-prefix libs and includes before the generic ones to avoid linking against th... Original commit message from CVS: * docs/libs/Makefile.am: Include our build-prefix libs and includes before the generic ones to avoid linking against the installed libs when we want the build-tree ones.
2007-07-26 14:05:23 +00:00
GTKDOC_CFLAGS = -I$(top_builddir) -I$(top_builddir)/libs $(GST_OBJ_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:05:03 +00:00
GTKDOC_LIBS = \
gst: Change versioning Remove GST_MAJORMINOR and replace it by GST_API_VERSION Also set GST_VERSION_{MAJOR,MINOR,MICRO,NANO} explicitely now. All versions are at 1.0.0 now for the release soon but API/ABI can still change until the 1.0.0 release. Next release versions until 1.0.0 will be 0.10.9X and these will be release candidates. GST_VERSION_* will nonetheless stay at 1.0.0.0.
2012-04-04 11:13:52 +00:00
$(top_builddir)/libs/gst/controller/libgstcontroller-@GST_API_VERSION@.la \
$(top_builddir)/libs/gst/base/libgstbase-@GST_API_VERSION@.la \
$(top_builddir)/libs/gst/net/libgstnet-@GST_API_VERSION@.la \
check: add GstTestClock as a deterministic clock for testing API: GstTestClock API: gst_test_clock_new() API: gst_test_clock_new_with_start_time() API: gst_test_clock_set_time() API: gst_test_clock_advance_time() https://bugzilla.gnome.org/show_bug.cgi?id=683012
2012-08-29 14:11:10 +00:00
$(top_builddir)/libs/gst/check/libgstcheck-@GST_API_VERSION@.la \
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:05:03 +00:00
$(GST_OBJ_LIBS)
converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +00:00
docs: set GST_PLUGIN_SCANNER when calling gtkdoc-scangobj Otherwise the docs build won't work properly
2009-11-17 09:06:48 +00:00
GTKDOC_EXTRA_ENVIRONMENT= \
Use GST_*_1_0 environment variables everywhere The _1_0 suffixed environment variables override the non-suffixed ones, so if we're in an environment that sets the _1_0 suffixed ones, such as jhbuild, we need to set those to make sure ours actually always get used.
2013-01-15 13:47:32 +00:00
GST_PLUGIN_SCANNER_1_0=$(top_builddir)/libs/gst/helpers/gst-plugin-scanner
docs: set GST_PLUGIN_SCANNER when calling gtkdoc-scangobj Otherwise the docs build won't work properly
2009-11-17 09:06:48 +00:00
converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +00:00
# If you need to override some of the declarations, place them in this file
# and uncomment this line.
docs: fix make distcheck No point removin those empty override files from git, they'll just be re-created later, so let's tell gtk-doc about them, so it can clean them up properly.
2011-09-07 14:07:20 +00:00
DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gno... Original commit message from CVS: converting to xml as intermediary step to fix devhelp generation assorted doc build fixes as well http://bugzilla.gnome.org/show_bug.cgi?id=113195
2003-05-18 15:04:26 +00:00
make libs use same gtk-doc.mak Original commit message from CVS: make libs use same gtk-doc.mak
2005-07-07 15:07:21 +00:00
include $(top_srcdir)/common/gtk-doc.mak
Reference in a new issue Copy permalink