From 8178973c4156f5f31f12ab92498408a9e96ebb04 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Fri, 14 May 2004 14:00:04 +0000 Subject: [PATCH] enabled gobject hierarchy in the gtk-doc enabled the GstQueue class in the gtk-doc added a few missing symbols so tha... Original commit message from CVS: enabled gobject hierarchy in the gtk-doc enabled the GstQueue class in the gtk-doc added a few missing symbols so that the hierachy works --- docs/gst/gstreamer-docs.sgml | 24 +++--- docs/gst/gstreamer-sections.txt | 8 +- docs/gst/gstreamer.types | 2 + docs/gst/tmpl/gstelement.sgml | 129 ++++++++++++++++++++++++++++++++ docs/gst/tmpl/gstpad.sgml | 14 ++++ docs/gst/tmpl/gstqueue.sgml | 92 +++++++++++++++++++++++ docs/gst/tmpl/gstscheduler.sgml | 34 +++++++++ docs/gst/tmpl/gsttypes.sgml | 32 ++++---- gst/gst.h | 2 + 9 files changed, 311 insertions(+), 26 deletions(-) diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 8d9e1a07b5..0548dfa3d6 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -4,7 +4,6 @@ %version-entities; - @@ -44,8 +43,9 @@ - @@ -61,7 +61,7 @@ - + ]> @@ -102,7 +102,9 @@ with some more specialized elements. &GstProbe; &GstQuery; +... +--> + &GstQueue; &GstRegistry; &GstRegistryPool; &GstScheduler; @@ -160,14 +162,12 @@ with some more specialized elements. --> - + + + diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index f5464c53eb..a0b1b33317 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -258,6 +258,8 @@ gst_data_get_type
gstelement +GstElement +GstElementClass GstElementDetails GST_ELEMENT_DETAILS GST_IS_ELEMENT_DETAILS @@ -594,6 +596,8 @@ GST_OBJECT_GET_CLASS
gstpad +GstPad +GstPadClass GstRealPad GstGhostPad GstRealPadClass @@ -843,9 +847,9 @@ GST_PLUGIN_FEATURE_GET_CLASS gstqueue GstQueue GstQueue +GstQueueClass GstQueueSize -GstQueueClass GST_QUEUE GST_IS_QUEUE GST_TYPE_QUEUE @@ -899,6 +903,8 @@ GST_REGISTRY_GET_CLASS
gstscheduler +GstScheduler +GstSchedulerClass GstSchedulerFlags GST_SCHEDULER_PARENT GST_SCHEDULER_STATE diff --git a/docs/gst/gstreamer.types b/docs/gst/gstreamer.types index ae5626c6d4..e36dcf93fa 100644 --- a/docs/gst/gstreamer.types +++ b/docs/gst/gstreamer.types @@ -17,3 +17,5 @@ gst_scheduler_get_type gst_index_get_type gst_index_factory_get_type gst_xml_get_type +gst_queue_get_type +gst_xml_registry_get_type diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index b4b98be6e2..db219c444f 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -65,6 +65,127 @@ and gst_element_set_clock(). You can wait for the clock to reach a given + + + + + + + + + + + +@: + +@gstelement: the object which received the signal. + + + + + + +@: +@: +@: +@: + +@gstelement: the object which received the signal. +@arg1: +@arg2: +@arg3: + + + + + + +@: +@: +@: + +@gstelement: the object which received the signal. +@arg1: +@arg2: + + + + + + +@: +@: + +@gstelement: the object which received the signal. +@arg1: + + + + + + +@gstelement: the object which received the signal. + + + + + + +@: +@: + +@gstelement: the object which received the signal. +@arg1: + + + + + + +@: +@: +@: + +@gstelement: the object which received the signal. +@arg1: +@arg2: + + + + + + +@parent_class: +@details: +@elementfactory: +@padtemplates: +@numpadtemplates: +@state_change: +@new_pad: +@pad_removed: +@error: +@eos: +@found_tag: +@set_property: +@get_property: +@release_locks: +@get_event_masks: +@send_event: +@get_formats: +@convert: +@get_query_types: +@query: +@change_state: +@request_new_pad: +@release_pad: +@get_clock: +@set_clock: +@get_index: +@set_index: +@set_state: +@no_more_pads: +@_gst_reserved: + This struct is used to define public information about the element. It @@ -1132,6 +1253,14 @@ Sets the parent of an element. + + + + + +@element: + + diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index d8b363ea14..5e93061959 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -57,6 +57,20 @@ Last reviewed on December 13th, 2002 (0.5.0.1) #GstPadTemplate, #GstElement, #GstEvent + + + + + + + + + + + +@parent_class: +@_gst_reserved: + diff --git a/docs/gst/tmpl/gstqueue.sgml b/docs/gst/tmpl/gstqueue.sgml index ce85996a72..5eb283adb6 100644 --- a/docs/gst/tmpl/gstqueue.sgml +++ b/docs/gst/tmpl/gstqueue.sgml @@ -31,6 +31,98 @@ The queue blocks by default. + + + + + +@gstqueue: the object which received the signal. + + + + + + +@gstqueue: the object which received the signal. + + + + + + +@gstqueue: the object which received the signal. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@parent_class: +@underrun: +@running: +@overrun: +@_gst_reserved: + diff --git a/docs/gst/tmpl/gstscheduler.sgml b/docs/gst/tmpl/gstscheduler.sgml index 661a0e9269..67a27a4071 100644 --- a/docs/gst/tmpl/gstscheduler.sgml +++ b/docs/gst/tmpl/gstscheduler.sgml @@ -14,6 +14,40 @@ This is a base class for custom schedulers. + + + + + + + + + + + +@parent_class: +@setup: +@reset: +@add_element: +@remove_element: +@add_scheduler: +@remove_scheduler: +@state_transition: +@scheduling_change: +@lock_element: +@unlock_element: +@yield: +@interrupt: +@error: +@pad_link: +@pad_unlink: +@pad_select: +@clock_wait: +@iterate: +@show: +@object_sync: +@_gst_reserved: + Flags for the scheduler diff --git a/docs/gst/tmpl/gsttypes.sgml b/docs/gst/tmpl/gsttypes.sgml index 184e756e84..dcf6af2d83 100644 --- a/docs/gst/tmpl/gsttypes.sgml +++ b/docs/gst/tmpl/gsttypes.sgml @@ -124,22 +124,20 @@ template. -Signal emited when the element goes to PAUSED due to an end-of-stream -condition. + @gstelement: the object which received the signal. -This signal is emitted when an element has encountered an error that caused -it to fail performing its function. + @gstelement: the object which received the signal. -@arg1: the original #GstElement that generated the error. -@arg2: a #GError containing the translated error message. -@arg3: a debug string providing additional untranslated debug information, or NULL. +@arg1: +@arg2: +@arg3: @@ -152,27 +150,34 @@ it to fail performing its function. -Is triggered whenever a new pad is added to an element. + + + +@gstelement: the object which received the signal. +@arg1: + + + + @gstelement: the object which received the signal. -@arg1: the new pad that was added -Is triggered whenever a pad has been removed from the element. + @gstelement: the object which received the signal. -@arg1: The pad that was removed. +@arg1: -Is triggered whenever the state of an element changes. + @gstelement: the object which received the signal. -@arg1: the new state of the object +@arg1: @arg2: @@ -208,6 +213,7 @@ Is triggered whenever the state of an element changes. @get_index: @set_index: @set_state: +@no_more_pads: @_gst_reserved: diff --git a/gst/gst.h b/gst/gst.h index 00dee0f0fd..215046717e 100644 --- a/gst/gst.h +++ b/gst/gst.h @@ -47,6 +47,7 @@ #include #include #include +#include #include #include #include @@ -64,6 +65,7 @@ #include #include #include +#include /* API compatibility stuff */ #include