Thibault Saunier
a87b4551a6
Port gtk-doc comments to their equivalent markdown syntax
...
Modernizing our documentation and preparing a possible move to hotdoc.
This commits also adds missing @title metadatas to all SECTIONs
2017-01-27 16:36:38 -03:00
Tim-Philipp Müller
e0de5ed915
iterator: only unset GValue if it was inited
...
And add some function guards. From GLib 2.48 on it is
allowed to pass an uninitialised GValue to g_value_unset().
https://bugzilla.gnome.org/show_bug.cgi?id=763762
2016-05-23 18:09:48 +01:00
Evan Nemerson
d11e657412
docs: annotate C examples as such
...
https://bugzilla.gnome.org/show_bug.cgi?id=731292
2016-02-15 17:45:15 +00:00
Nirbheek Chauhan
b627201e7e
iterator: Fix outdated example code and accompanying documentation
...
GstIterator no longer returns a refcounted gpointer
2014-12-27 10:59:31 +00:00
Evan Nemerson
e10266e3f3
docs: convert NULL, TRUE, and FALSE to %NULL, %TRUE, and %FALSE
...
This should help improve documentation generated for
languages other than C.
https://bugzilla.gnome.org/show_bug.cgi?id=730961
2014-05-30 00:20:27 +01:00
Tim-Philipp Müller
6eb6d9ec38
docs: remove outdated and pointless 'Last reviewed' lines from docs
...
They are very confusing for people, and more often than not
also just not very accurate. Seeing 'last reviewed: 2005' in
your docs is not very confidence-inspiring. Let's just remove
those comments.
2014-04-26 21:21:51 +01:00
Stefan Sauer
c068b225fe
docs: convert the examples to use gtk-doc markup, instead of docbook
...
The gtk-doc markup is less intrusive and better handled when creating docs for
language bindings. The titles (where used) where not adding much.
2014-02-27 18:11:35 +01:00
Sebastian Dröge
bac1202cf7
iterator: Properly copy mutexes around when creating a copy of a filter iterator
2014-01-18 14:48:54 +01:00
Stewart Brodie
f77d79f2f8
iterator: Preserve the master lock when creating recursive iterator filters with the same lock
...
This way we make sure that a) the lock is always taken when checking
the cookie and calling the iterator's next functions and b) it is
not taken while calling any of the iterator filter functions.
https://bugzilla.gnome.org/show_bug.cgi?id=711138
2014-01-18 14:48:54 +01:00
Sebastian Rasmussen
53ae1b2c9c
docs: Fix typos in function/object descriptions
...
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=720029
2013-12-07 17:11:12 +00:00
Tim-Philipp Müller
666c8c11c6
Fix FSF address
...
https://bugzilla.gnome.org/show_bug.cgi?id=687520
2012-11-03 20:44:48 +00:00
Edward Hervey
d3ffa82639
Remove 0.10-related documentation and "Since" markers
2012-07-10 12:03:27 +02:00
Wim Taymans
ce67b0e539
docs: update more documentation
2012-03-29 13:34:50 +02:00
Olivier Crête
e234a10c63
Use macros to register boxed types thread safely
2012-01-28 16:42:38 +00:00
Edward Hervey
88095c406e
gstiterator: Add skip annotation for creating GstIterator
...
Not really useful for bindings
2011-10-19 11:59:29 +02:00
Peteris Krisjanis
59bf122584
iterator: Fix gst_iterator_next() element annotation
2011-08-12 11:48:49 +02:00
Tim-Philipp Müller
4b920eb5d2
docs: update for API changes
...
Also remove GST_PAD_CHECKGETRANGEFUNC macro
2011-06-05 18:57:56 +01:00
Sebastian Dröge
348563bc19
iterator: Refactor GstIterator to be more binding friendly and have saner refcounting
...
Fixes bug #638987 .
2011-05-05 15:33:29 +02:00
Johan Dahlin
62c7339847
iterator: register as a boxed type
...
https://bugzilla.gnome.org/show_bug.cgi?id=638987
2011-05-05 15:33:29 +02:00
Johan Dahlin
b5a4aad134
iterator: use GSlice
...
https://bugzilla.gnome.org/show_bug.cgi?id=638987
2011-05-05 15:33:29 +02:00
Johan Dahlin
0e2cf0caa1
iterator: free struct in gst_iterator_free
...
https://bugzilla.gnome.org/show_bug.cgi?id=638987
2011-05-05 15:33:28 +02:00
Johan Dahlin
47ebd0755b
iterator: store size in the struct
...
https://bugzilla.gnome.org/show_bug.cgi?id=638987
2011-05-05 15:33:28 +02:00
Sebastian Dröge
bf6c3ea6df
gst: Add some more gobject-introspection annotations
2011-04-14 16:14:01 +02:00
Stian Selnes
c19f44e1d2
iterator: resync to avoid infinite loop
2011-04-08 14:43:21 +02:00
Sebastian Dröge
18f23bc0b0
iterator: Add new FIXME for 0.11 and update gst_iterator_find_custom docs
...
The compare function should only unref the element if it's
not the matching element.
Also the FIXME in _fold() is not relevant because the ref/unref
happens in the fold function.
2010-06-13 15:25:24 +02:00
Sebastian Dröge
c4ccbe093e
iterator: If the iterator resync in find_custom() just retry
2010-06-13 11:25:53 +02:00
Sebastian Dröge
ad230b07f6
iterator: Add FIXME 0.11 for using GSlice for allocation
2010-03-28 19:48:54 +02:00
Peter Kjellerstedt
1314aa75d5
iterator: Fix a documentation typo
2009-10-14 10:16:31 +02:00
Sebastian Dröge
690f980690
iterator: Only visit the element a single time in the single iterator
2009-09-01 10:20:59 +02:00
Sebastian Dröge
66e5d4ee4b
iterator: Fix single iterator for NULL objects and non-GTypeInstance objects
...
Fixes bug #593719 .
2009-09-01 07:28:43 +02:00
Wim Taymans
f90a9a8092
iterator: fix docs for _new_single().
2009-08-31 20:38:07 +02:00
Tim-Philipp Müller
5dc534c642
docs: it's its
...
The panda says no!
2009-08-31 17:00:17 +01:00
Sebastian Dröge
a1ae8a3a3e
iterator: Allow to use NULL as object for the single iterator
2009-08-26 16:51:32 +02:00
Sebastian Dröge
b2cab40745
iterator: API: Add gst_iterator_new_single()
...
This allows "iteration" over a single object of some type,
which happens often for the GstPadIterIntLinksFunction for example.
2009-08-26 16:39:19 +02:00
Christopher Halse Rogers
2896964ec2
iterator: Explicitly mention refcounting in docs
...
Fixes #585938
2009-06-16 11:21:42 +02:00
Stefan Kost
15e7d1e9c7
docs: fix linking to constant and functions
2009-03-12 00:41:24 +02:00
Wim Taymans
e6da27eb3b
gst/gstiterator.*: After 3 years it's about time to revise the documentation of the iterator objects.
...
Original commit message from CVS:
* gst/gstiterator.c:
* gst/gstiterator.h:
After 3 years it's about time to revise the documentation of the
iterator objects.
2008-08-29 17:58:25 +00:00
Sebastian Dröge
a31349a80e
gst/gstiterator.c: Remove an unused field from the private GstListIterator struct.
...
Original commit message from CVS:
* gst/gstiterator.c:
Remove an unused field from the private GstListIterator struct.
2008-05-28 07:47:22 +00:00
Stefan Kost
a53172d79d
doc fixes, to link to function, just write gst_cool_function(), don't prefix with '#'
...
Original commit message from CVS:
* gst/gstcaps.c:
* gst/gstelement.c: (gst_element_send_event):
* gst/gstevent.c:
* gst/gstinfo.c:
* gst/gstiterator.c:
* gst/gstiterator.h:
* gst/gstpad.c: (gst_pad_send_event):
* gst/gststructure.c:
* gst/gsturi.c:
* gst/gstutils.c:
* gst/gstvalue.c:
* libs/gst/base/gstadapter.c:
doc fixes, to link to function, just write gst_cool_function(), don't
prefix with '#'
2006-01-27 22:34:51 +00:00
Stefan Kost
7b347681d5
gst/gstelement.c: don't loop forever
...
Original commit message from CVS:
* gst/gstelement.c: (gst_element_dispose):
don't loop forever
* gst/gstiterator.c:
* gst/gststructure.c:
doc fixes
* libs/gst/controller/gstcontroller.c:
(gst_controlled_property_set_interpolation_mode):
* libs/gst/controller/gstcontroller.h:
* libs/gst/controller/gstinterpolation.c:
(interpolate_none_get_enum_value_array):
support controlling enums
2005-11-27 22:43:08 +00:00
Wim Taymans
5151ea3d9b
gst/gstiterator.c: Fix revision data.
...
Original commit message from CVS:
* gst/gstiterator.c:
Fix revision data.
* gst/gsttask.c:
* gst/gsttask.h:
Fix docs.
2005-11-09 16:32:49 +00:00
Wim Taymans
6938d93206
gst/gstiterator.*: Fix iterator docs.
...
Original commit message from CVS:
* gst/gstiterator.c: (gst_iterator_fold), (gst_iterator_foreach),
(gst_iterator_find_custom):
* gst/gstiterator.h:
Fix iterator docs.
2005-11-09 15:31:08 +00:00
Wim Taymans
563477a64e
gst/gstbin.c: Fix typo in docs.
...
Original commit message from CVS:
* gst/gstbin.c:
Fix typo in docs.
* gst/gstelement.c: (gst_element_commit_state):
Remove unused value.
* gst/gstiterator.c:
Mention that the returned element is reffed in the docs.
2005-11-02 18:44:20 +00:00
Wim Taymans
a71cbb326b
Doc updates.
...
Original commit message from CVS:
* docs/design/part-TODO.txt:
* gst/gstiterator.c:
* gst/gstsystemclock.c:
* gst/gstsystemclock.h:
Doc updates.
2005-10-28 18:14:24 +00:00
Wim Taymans
b3354de0b7
docs/design/part-TODO.txt: Add an item to TODO.
...
Original commit message from CVS:
* docs/design/part-TODO.txt:
Add an item to TODO.
* gst/gstiterator.c: (gst_iterator_fold),
(gst_iterator_find_custom):
* gst/gstiterator.h:
Add iterator docs.
2005-10-28 16:21:29 +00:00
Thomas Vander Stichele
bef56ce78d
various style fixes
...
Original commit message from CVS:
various style fixes
2005-10-15 16:01:57 +00:00
Thomas Vander Stichele
2dd1598c56
whitespace fixes
...
Original commit message from CVS:
whitespace fixes
2005-10-15 15:30:24 +00:00
Tim-Philipp Müller
29e78cb4b0
gst/gstiterator.c: Fix my previous commit: GTypes passed to gst_iterator_new() can be fundamental types.
...
Original commit message from CVS:
* gst/gstiterator.c: (gst_iterator_new):
Fix my previous commit: GTypes passed to gst_iterator_new()
can be fundamental types.
2005-10-10 15:58:32 +00:00
Tim-Philipp Müller
a1702b7646
gst/gstiterator.c: Add assertions to make sure passed GType is likely to really be a GType (as the compiler won't cat...
...
Original commit message from CVS:
* gst/gstiterator.c: (gst_iterator_new):
Add assertions to make sure passed GType is likely to really
be a GType (as the compiler won't catch it if the size and
GType arguments get mixed up, see #318447 ).
2005-10-10 15:30:45 +00:00
Johan Dahlin
25a0f8c57f
Add a GType to GstIterator, update callsites and tests.
...
Original commit message from CVS:
* check/gst/gstiterator.c: (GST_START_TEST):
* gst/gstbin.c: (gst_bin_iterate_elements),
(gst_bin_iterate_recurse), (gst_bin_iterate_sorted):
* gst/gstelement.c: (gst_element_iterate_pads):
* gst/gstformat.c: (gst_format_iterate_definitions):
* gst/gstiterator.c: (gst_iterator_init), (gst_iterator_new),
(gst_iterator_new_list), (gst_iterator_filter):
* gst/gstiterator.h:
* gst/gstquery.c: (gst_query_type_iterate_definitions):
Add a GType to GstIterator, update callsites and tests.
2005-10-07 00:14:45 +00:00