Commit graph

79 commits

Author SHA1 Message Date
Edward Hervey
22fac0b212 docs: Update libs documentation
* Make sure all libcheck headers are ignored
* Add all missing symbols
2018-04-02 12:44:15 +02:00
Tim-Philipp Müller
99df754c22 docs: fixup for new libs API export decorators 2018-03-13 00:57:37 +00:00
Stefan Sauer
3325ebb616 docs: use the full path to ignore dirs 2017-05-13 18:19:05 +02:00
Sebastian Dröge
2d38699144 docs: Hide NTP packet API and add GST_PTP_STATISTICS_* defines to the docs 2016-01-06 19:42:49 +02:00
Stefan Sauer
8b6ad65e63 docs: cleanup -unused.txt report for libs
The IGNORE_H_FILES can only contain files or dirs.
2016-01-06 18:14:06 +01:00
Stefan Sauer
39d3779c53 docs: remove variables that we define in the snippet from common
This is syncing our Makefile.am with upstream gtkdoc.
2015-06-07 17:17:36 +02:00
Stefan Sauer
0461c9f21d docs: ignore libcheck headers that use doxygen comments 2014-12-29 12:05:27 +01:00
Sebastian Rasmussen
49950e57ad 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-12-03 00:11:59 +00:00
Tim-Philipp Müller
64eee27ebc 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
Sebastian Rasmussen
e58da2a22d 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-11-13 21:19:57 +00:00
Tim-Philipp Müller
bf2452d776 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 12:56:30 +01:00
Sebastian Dröge
b0d89da6b6 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 14:28:55 +02:00
Stefan Sauer
6f29ac8bb1 controller: update docs for controller move 2011-11-04 20:11:51 +01:00
Tim-Philipp Müller
92ad7f0d6b 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 15:09:58 +01:00
Stefan Sauer
dbfc0d9b35 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 14:08:35 +02:00
Stefan Kost
3e475c4d33 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-24 18:32:20 +02:00
Tim-Philipp Müller
3c7c9692ac plugin-scanner: rename plugin-scanner helper binary to gst-plugin-scanner
and install into a different directory $(libexecdir/gstreamer-0.10) so that
everything is versioned properly.

NOTE: run 'make clean' after updating; if you are running an uninstalled setup,
you will need to update your gst-uninstalled script (unless it's symlinked
to gstreamer core master) and exit/enter your uninstalled environment to get
the updated environment. If you are running an installed setup, you should
run 'make uninstall' before merging this change or remove the old
plugin-scanner binary manually.

Fixes #601698.
2009-11-18 09:28:08 +00:00
Tim-Philipp Müller
a5280fdb6b docs: set GST_PLUGIN_SCANNER when calling gtkdoc-scangobj
Otherwise the docs build won't work properly
2009-11-17 09:09:22 +00:00
Jan Schmidt
29170a4cfa 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 13:16:29 +01:00
Jan Schmidt
9192c7f9a5 Use shave (http://git.lespiau.name/cgit/shave/) to simplify build output 2009-02-22 16:09:42 +00:00
Tim-Philipp Müller
9f496df370 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 18:12:35 +00:00
Tim-Philipp Müller
e188794cdf 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
Tim-Philipp Müller
e8dbc8e01a docs/libs/Makefile.am: Fix docs build again by adding libgstnet-0.10.so to SCANOBJ_DEPS.
Original commit message from CVS:
* docs/libs/Makefile.am:
Fix docs build again by adding libgstnet-0.10.so to SCANOBJ_DEPS.
2008-04-21 09:29:37 +00:00
Stefan Kost
2cf1e35694 docs/: Remove cruft and do some cleanups.
Original commit message from CVS:
* docs/gst/Makefile.am:
* docs/libs/Makefile.am:
Remove cruft and do some cleanups.
* docs/gst/gstreamer-docs.sgml:
* docs/libs/gstreamer-libs-docs.sgml:
Prepare for comming gtkdoc features (rebase against online docs).
2007-08-10 17:35:30 +00:00
Jan Schmidt
ce3c96049e 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
Stefan Kost
06aa9c442b 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
Stefan Kost
b7e503a7f9 docs/: Correct fixxrefs options.
Original commit message from CVS:
* docs/gst/Makefile.am:
* docs/libs/Makefile.am:
Correct fixxrefs options.
* docs/plugins/Makefile.am:
* docs/plugins/gstreamer-plugins-docs.sgml:
* docs/plugins/gstreamer-plugins-sections.txt:
* plugins/elements/Makefile.am:
* plugins/elements/gstcapsfilter.c (gst_capsfilter_details):
* plugins/elements/gstcapsfilter.h (__GST_CAPSFILTER_H__,
GST_TYPE_CAPSFILTER, GST_CAPSFILTER, GST_CAPSFILTER_CLASS,
GST_IS_CAPSFILTER, GST_IS_CAPSFILTER_CLASS, GstCapsFilter,
GstCapsFilterClass, _GstCapsFilter, trans, filter_caps,
_GstCapsFilterClass, trans_class):
* plugins/elements/gstelements.c (name, rank, type, _elements):
* plugins/elements/gstidentity.c
(gst_identity_check_imperfect_timestamp,
gst_identity_check_imperfect_offset):
Document capsfilter and add doc-blurb to identity.
2007-05-06 18:27:25 +00:00
Stefan Kost
f7f2e89e63 Add crossreferences to glib/gobject docs.
Original commit message from CVS:
* configure.ac:
* docs/gst/Makefile.am:
* docs/libs/Makefile.am:
* docs/plugins/Makefile.am:
Add crossreferences to glib/gobject docs.
2007-02-12 19:55:24 +00:00
Stefan Kost
85c81ea952 docs/libs/Makefile.am: Fix path to core docs.
Original commit message from CVS:
* docs/libs/Makefile.am:
Fix path to core docs.
* gst/gstbin.c: (gst_bin_get_by_interface),
(gst_bin_iterate_all_by_interface):
Refix docs by also renaming 'interface' to 'iface' in implementation.
* docs/gst/gstreamer-sections.txt:
* gst/gstcaps.c:
* gst/gstchildproxy.c: (gst_child_proxy_base_init):
* gst/gstchildproxy.h:
* gst/gstelementfactory.c:
* gst/gstpadtemplate.h:
* libs/gst/controller/gstcontroller.c:
(gst_controlled_property_new):
Document more.
2007-02-11 19:59:12 +00:00
Stefan Kost
04f6dc0ab7 docs/libs/: add types of base classes to enable gobject specific stuff in the docs
Original commit message from CVS:
* docs/libs/Makefile.am:
* docs/libs/gstreamer-libs.types:
add types of base classes to enable gobject specific stuff in the docs
* docs/random/ensonic/embedded.txt:
more ideas about isolating platform specific things
2006-11-21 08:30:20 +00:00
Thomas Vander Stichele
0734eb921c 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
Thomas Vander Stichele
3795e5a571 move upload.mak to common
Original commit message from CVS:
* common/Makefile.am:
* docs/Makefile.am:
* docs/faq/Makefile.am:
* docs/gst/Makefile.am:
* docs/libs/Makefile.am:
* docs/manual/Makefile.am:
* docs/plugins/Makefile.am:
* docs/pwg/Makefile.am:
* docs/slides/Makefile.am:
* docs/upload.mak:
* common/upload.mak:
move upload.mak to common
2006-04-29 00:36:47 +00:00
Stefan Kost
72396245b5 Fix distcheck issues for the libraries docs build
Original commit message from CVS:

Patch by: Stefan Kost

* common/gtk-doc.mak:
* docs/gst/Makefile.am:
* docs/libs/Makefile.am:
Fix distcheck issues for the libraries docs build
Closes #319599
2005-11-24 16:32:26 +00:00
Ronald
ac8289c7a9 Merged in popt removal + GOption addition patch from Ronald, bug #169772.
Original commit message from CVS:
2005-10-10  Andy Wingo  <wingo@pobox.com>

Merged in popt removal + GOption addition patch from Ronald, bug
#169772.

* docs/gst/gstreamer-sections.txt: Add STATE_(UN)LOCK_FULL, move
GstElement macros around, remove popt-related symbols, add goption
stuff.

* configure.ac: Remove popt checks, require GLib 2.6 for GOption.

* docs/gst/Makefile.am:
* docs/libs/Makefile.am: No POPT_CFLAGS.

* examples/manual/Makefile.am:
* docs/manual/basics-init.xml: Doc updates with an example.

* gst/gst.c: (gst_init_get_option_group), (gst_init_check),
(gst_init), (parse_one_option), (parse_goption_arg):
* gst/gst.h: Removed gst_init_with_popt_table and friends. Took a
bit of hand merging and debugging to get the GOption stuff working
tho.

* tests/Makefile.am:
* tools/Makefile.am:
* tools/gst-inspect.c: (main):
* tools/gst-launch.c: (main):
* tools/gst-run.c: (main):
* tools/gst-xmlinspect.c: (main): Thanks Ronald!
2005-10-10 15:53:59 +00:00
Stefan Kost
c32233b7fc 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
Stefan Kost
990ddc3b22 remove dparams deps from the docs
Original commit message from CVS:
remove dparams deps from the docs
2005-08-01 16:43:58 +00:00
Thomas Vander Stichele
854b4bb560 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
Stefan Kost
acb843cb22 fixed make distcheck with gtk-doc 1.3
Original commit message from CVS:
fixed make distcheck with gtk-doc 1.3
2005-06-24 07:49:40 +00:00
Andy Wingo
a7ad017d05 docs/: Dist the overrides files.
Original commit message from CVS:
2005-03-29  Andy Wingo  <wingo@pobox.com>

* docs/gst/Makefile.am:
* docs/libs/Makefile.am: Dist the overrides files.

* check/Makefile.am (clean-local): Remove .libs directories.

* gst/elements/Makefile.am (EXTRA_DIST): Add all the attic
elements to EXTRA_DIST, so po/ files are happy.
2005-03-29 14:12:48 +00:00
Andy Wingo
ce469c1dcc po/POTFILES: Remove gstspider.c.
Original commit message from CVS:
2005-03-29  Andy Wingo  <wingo@pobox.com>

* po/POTFILES: Remove gstspider.c.

* configure.ac (AC_OUTPUT): Add missing testsuite makefiles.

* docs/libs/gstreamer-libs-docs.sgml:
* docs/libs/gstreamer-libs-sections.txt: Remove the section on
bytestream.

* tests/complexity.c (main): Set the length of the preroll queue
on the sinks to prevent a lockup.
2005-03-29 13:10:25 +00:00
Thomas Vander Stichele
7d4458ada9 fix for #147782 - get POPT flags in gtk-doc build
Original commit message from CVS:
fix for #147782 - get POPT flags in gtk-doc build
2005-02-11 10:00:15 +00:00
Stefan Kost
8f9fca9ea9 fixed install rules to treat style.css as optional
Original commit message from CVS:
fixed install rules to treat style.css as optional
2005-01-25 13:09:06 +00:00
Stefan Kost
c44852739c install style.css along with docs fixing incomplete docs
Original commit message from CVS:
install style.css along with docs
fixing incomplete docs
2005-01-24 17:04:08 +00:00
Stefan Kost
ca511598f4 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
Thomas Vander Stichele
e63b35bbd1 fix it properly before removing this
Original commit message from CVS:
fix it properly before removing this
2004-08-24 09:20:16 +00:00
David Schleef
aa6049eb61 docs/gst/Makefile.am: Remove --ignore-fail-on-non-empty (#150331)
Original commit message from CVS:
* docs/gst/Makefile.am: Remove --ignore-fail-on-non-empty (#150331)
* docs/libs/Makefile.am: same
* docs/gst/tmpl/gstxml.sgml: Remove GstXMLNs
* docs/random/ds/0.9-planning: random additions
* docs/random/ds/0.9-suggested-changes: same
* gst/gstxml.h: remove vestigal GstXMLNs definition
Preferred caps: (#147789)
* docs/gst/gstreamer-sections.txt: Add symbols
* docs/gst/tmpl/gstcaps.sgml: Add symbols
* gst/gstcaps.c: (gst_caps_copy), (gst_caps_free),
(gst_caps_append), (gst_caps_copy_1), (gst_caps_intersect),
(gst_caps_union), (gst_caps_save_thyself), (gst_caps_load_thyself),
(gst_caps_get_preferred), (gst_caps_set_preferred),
(gst_caps_get_structure_by_id), (gst_caps_prefer_foreach),
(gst_caps_use_preferred): Handle caps preferences
* gst/gstcaps.h: Add caps preferences
* gst/gstpad.c: (gst_pad_link_get_preferred),
(gst_pad_link_fixate), (gst_pad_link_call_link_functions),
(gst_pad_renegotiate), (gst_pad_guess_preferred),
(gst_pad_get_caps), (gst_pad_push):  Use caps preferences for
negotiation.
2004-08-18 21:46:55 +00:00
Thomas Vander Stichele
2270883f00 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
Thomas Vander Stichele
21c0f31205 doh
Original commit message from CVS:
doh
2004-07-28 12:30:08 +00:00
Thomas Vander Stichele
06bb8beb03 fix gst-libs docs build
Original commit message from CVS:
fix gst-libs docs build
2004-07-28 11:56:19 +00:00
Thomas Vander Stichele
6c62ed8d46 fix docs build
Original commit message from CVS:
fix docs build
2004-07-28 10:19:18 +00:00