[perl-gstreamer] Applied POD patch from Debian project (closes RT#43550)

From: Brian Manning <bmanning src gnome org>
To: commits-list gnome org
Cc:
Subject: [perl-gstreamer] Applied POD patch from Debian project (closes RT#43550)
Date: Thu, 8 Oct 2020 05:15:53 +0000 (UTC)
commit 5e58775af1e6c9f16976d4b36d76d3ba95071a9e
Author: Brian Manning <bmanning src gnome org>
Date:   Wed Oct 7 21:51:51 2020 -0700

    Applied POD patch from Debian project (closes RT#43550)

 xs/Gst.xs                |  4 +++
 xs/GstBin.xs             |  4 +++
 xs/GstBuffer.xs          |  4 +++
 xs/GstBus.xs             |  4 +++
 xs/GstCaps.xs            | 20 +++++++++++++
 xs/GstChildProxy.xs      |  4 +++
 xs/GstClock.xs           |  8 +++++
 xs/GstElement.xs         |  4 +++
 xs/GstElementFactory.xs  |  4 +++
 xs/GstEvent.xs           | 44 ++++++++++++++++++++++++++++
 xs/GstFormat.xs          |  4 +++
 xs/GstGhostPad.xs        |  4 +++
 xs/GstIndex.xs           |  8 +++++
 xs/GstIndexFactory.xs    |  4 +++
 xs/GstIterator.xs        |  8 +++++
 xs/GstMessage.xs         | 76 ++++++++++++++++++++++++++++++++++++++++++++++++
 xs/GstMiniObject.xs      |  4 +++
 xs/GstObject.xs          |  4 +++
 xs/GstPad.xs             |  4 +++
 xs/GstPadTemplate.xs     |  4 +++
 xs/GstPipeline.xs        |  4 +++
 xs/GstPlugin.xs          |  4 +++
 xs/GstPluginFeature.xs   |  4 +++
 xs/GstQuery.xs           | 28 ++++++++++++++++++
 xs/GstRegistry.xs        |  4 +++
 xs/GstStructure.xs       |  4 +++
 xs/GstSystemClock.xs     |  4 +++
 xs/GstTag.xs             |  4 +++
 xs/GstTagSetter.xs       |  4 +++
 xs/GstTypeFindFactory.xs |  4 +++
 xs/GstValue.xs           |  4 +++
 31 files changed, 288 insertions(+)
---
diff --git a/xs/Gst.xs b/xs/Gst.xs
index 13f8949..6e13ce2 100644
--- a/xs/Gst.xs
+++ b/xs/Gst.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer     PACKAGE = GStreamer     PREFIX = gst_
 
+=for object GStreamer Media library supporting arbitrary formats and filter graphs.
+
+=cut
+
 BOOT:
 #include "register.xsh"
 #include "boot.xsh"
diff --git a/xs/GstBin.xs b/xs/GstBin.xs
index cdf1222..ef72450 100644
--- a/xs/GstBin.xs
+++ b/xs/GstBin.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::Bin        PACKAGE = GStreamer::Bin        PREFIX = gst_bin_
 
+=for object GStreamer::Bin Base class and element that can contain other elements
+
+=cut
+
 BOOT:
        gperl_object_set_no_warn_unreg_subclass (GST_TYPE_BIN, TRUE);
 
diff --git a/xs/GstBuffer.xs b/xs/GstBuffer.xs
index 8106b68..31493ac 100644
--- a/xs/GstBuffer.xs
+++ b/xs/GstBuffer.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::Buffer     PACKAGE = GStreamer::Buffer     PREFIX = gst_buffer_
 
+=for object GStreamer::Buffer Data-passing buffer type, supporting sub-buffers.
+
+=cut
+
 # DESTROY inherited from GStreamer::MiniObject.
 
 GstBufferFlag
diff --git a/xs/GstBus.xs b/xs/GstBus.xs
index 5ae7756..8040fc9 100644
--- a/xs/GstBus.xs
+++ b/xs/GstBus.xs
@@ -68,6 +68,10 @@ bus_watch (GstBus *bus, GstMessage *message, gpointer data)
 
 MODULE = GStreamer::Bus        PACKAGE = GStreamer::Bus        PREFIX = gst_bus_
 
+=for object GStreamer::Bus Asynchronous message bus subsystem
+
+=cut
+
 # GstBus * gst_bus_new (void);
 GstBus * gst_bus_new (class)
     C_ARGS:
diff --git a/xs/GstCaps.xs b/xs/GstCaps.xs
index 4f03af6..7023901 100644
--- a/xs/GstCaps.xs
+++ b/xs/GstCaps.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::Caps       PACKAGE = GStreamer::Caps::Empty
 
+=for object GStreamer::Caps::Empty Structure describing sets of media formats
+
+=cut
+
 # GstCaps * gst_caps_new_empty (void);
 GstCaps_own *
 new (class)
@@ -33,6 +37,10 @@ new (class)
 
 MODULE = GStreamer::Caps       PACKAGE = GStreamer::Caps::Any
 
+=for object GStreamer::Caps::Any Structure describing sets of media formats
+
+=cut
+
 # GstCaps * gst_caps_new_any (void);
 GstCaps_own *
 new (class)
@@ -43,6 +51,10 @@ new (class)
 
 MODULE = GStreamer::Caps       PACKAGE = GStreamer::Caps::Simple
 
+=for object GStreamer::Caps::Simple Structure describing sets of media formats
+
+=cut
+
 # GstCaps * gst_caps_new_simple (const char *media_type, const char *fieldname, ...);
 GstCaps_own *
 new (class, media_type, field, type, value, ...)
@@ -79,6 +91,10 @@ new (class, media_type, field, type, value, ...)
 
 MODULE = GStreamer::Caps       PACKAGE = GStreamer::Caps::Full
 
+=for object GStreamer::Caps::Full Structure describing sets of media formats
+
+=cut
+
 # GstCaps * gst_caps_new_full (GstStructure  *struct1, ...);
 # GstCaps * gst_caps_new_full_valist (GstStructure  *structure, va_list var_args);
 GstCaps_own *
@@ -100,6 +116,10 @@ new (class, structure, ...)
 
 MODULE = GStreamer::Caps       PACKAGE = GStreamer::Caps       PREFIX = gst_caps_
 
+=for object GStreamer::Caps Structure describing sets of media formats
+
+=cut
+
 =for position SYNOPSIS
 
 =head1 SYNOPSIS
diff --git a/xs/GstChildProxy.xs b/xs/GstChildProxy.xs
index 847aaf5..1bdf304 100644
--- a/xs/GstChildProxy.xs
+++ b/xs/GstChildProxy.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::ChildProxy PACKAGE = GStreamer::ChildProxy PREFIX = gst_child_proxy_
 
+=for object GStreamer::ChildProxy Interface for multi child elements.
+
+=cut
+
 =for position DESCRIPTION
 
 =head1 DESCRIPTION
diff --git a/xs/GstClock.xs b/xs/GstClock.xs
index 4c32283..ed29d6e 100644
--- a/xs/GstClock.xs
+++ b/xs/GstClock.xs
@@ -127,6 +127,10 @@ gst2perl_clock_callback (GstClock *clock,
 
 MODULE = GStreamer::Clock      PACKAGE = GStreamer::Clock      PREFIX = gst_clock_
 
+=for object GStreamer::Clock Abstract class for global clocks
+
+=cut
+
 BOOT:
        gperl_object_set_no_warn_unreg_subclass (GST_TYPE_CLOCK, TRUE);
 
@@ -172,6 +176,10 @@ GstClockID gst_clock_new_periodic_id (GstClock *clock, GstClockTime start_time,
 
 MODULE = GStreamer::Clock      PACKAGE = GStreamer::ClockID    PREFIX = gst_clock_id_
 
+=for object GStreamer::ClockID Abstract class for global clocks
+
+=cut
+
 void
 DESTROY (id)
        GstClockID id
diff --git a/xs/GstElement.xs b/xs/GstElement.xs
index ee04bcc..62402df 100644
--- a/xs/GstElement.xs
+++ b/xs/GstElement.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::Element    PACKAGE = GStreamer::Element    PREFIX = gst_element_
 
+=for object GStreamer::Element Abstract base class for all pipeline elements
+
+=cut
+
 # FIXME?
 # void gst_element_class_add_pad_template (GstElementClass *klass, GstPadTemplate *templ);
 # GstPadTemplate* gst_element_class_get_pad_template (GstElementClass *element_class, const gchar *name);
diff --git a/xs/GstElementFactory.xs b/xs/GstElementFactory.xs
index 208272c..37f2ef5 100644
--- a/xs/GstElementFactory.xs
+++ b/xs/GstElementFactory.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::ElementFactory     PACKAGE = GStreamer::ElementFactory     PREFIX = gst_element_factory_
 
+=for object GStreamer::ElementFactory Create GstElements from a factory
+
+=cut
+
 # FIXME?
 # gboolean gst_element_register (GstPlugin *plugin, const gchar *name, guint rank, GType type);
 
diff --git a/xs/GstEvent.xs b/xs/GstEvent.xs
index 803e549..63c424b 100644
--- a/xs/GstEvent.xs
+++ b/xs/GstEvent.xs
@@ -78,6 +78,10 @@ get_package (GstEvent *event)
 
 MODULE = GStreamer::Event      PACKAGE = GStreamer::Event      PREFIX = gst_event_
 
+=for object GStreamer::Event Structure describing events that are passed up and down a pipeline
+
+=cut
+
 BOOT:
        gperl_set_isa ("GStreamer::Event::FlushStart", "GStreamer::Event");
        gperl_set_isa ("GStreamer::Event::FlushStop", "GStreamer::Event");
@@ -181,6 +185,10 @@ type (GstEvent *event)
 
 MODULE = GStreamer::Event      PACKAGE = GStreamer::Event::Custom
 
+=for object GStreamer::Event::Custom Structure describing events that are passed up and down a pipeline
+
+=cut
+
 # GstEvent * gst_event_new_custom (GstEventType type, GstStructure *structure);
 GstEvent_noinc *
 new (class, GstEventType type, GstStructure *structure)
@@ -194,6 +202,10 @@ new (class, GstEventType type, GstStructure *structure)
 
 MODULE = GStreamer::Event      PACKAGE = GStreamer::Event::FlushStart
 
+=for object GStreamer::Event::FlushStart Structure describing events that are passed up and down a pipeline
+
+=cut
+
 # GstEvent * gst_event_new_flush_start (void);
 GstEvent_noinc *
 new (class)
@@ -206,6 +218,10 @@ new (class)
 
 MODULE = GStreamer::Event      PACKAGE = GStreamer::Event::FlushStop
 
+=for object GStreamer::Event::FlushStop Structure describing events that are passed up and down a pipeline
+
+=cut
+
 # GstEvent * gst_event_new_flush_stop (void);
 GstEvent_noinc *
 new (class)
@@ -218,6 +234,10 @@ new (class)
 
 MODULE = GStreamer::Event      PACKAGE = GStreamer::Event::EOS
 
+=for object GStreamer::Event::EOS Structure describing events that are passed up and down a pipeline
+
+=cut
+
 # GstEvent * gst_event_new_eos (void);
 GstEvent_noinc *
 new (class)
@@ -230,6 +250,10 @@ new (class)
 
 MODULE = GStreamer::Event      PACKAGE = GStreamer::Event::NewSegment
 
+=for object GStreamer::Event::NewSegment Structure describing events that are passed up and down a pipeline
+
+=cut
+
 # GstEvent * gst_event_new_new_segment (gboolean update, gdouble rate, GstFormat format, gint64 start_value, 
gint64 stop_value, gint64 stream_time);
 GstEvent_noinc *
 new (class, gboolean update, gdouble rate, GstFormat format, gint64 start_value, gint64 stop_value, gint64 
stream_time)
@@ -291,6 +315,10 @@ update (GstEvent *event)
 
 MODULE = GStreamer::Event      PACKAGE = GStreamer::Event::Tag
 
+=for object GStreamer::Event::Tag Structure describing events that are passed up and down a pipeline
+
+=cut
+
 # GstEvent * gst_event_new_tag (GstTagList *taglist);
 GstEvent_noinc *
 new (class, GstTagList *taglist)
@@ -312,6 +340,10 @@ tag (GstEvent *event)
 
 MODULE = GStreamer::Event      PACKAGE = GStreamer::Event::BufferSize
 
+=for object GStreamer::Event::BufferSize Structure describing events that are passed up and down a pipeline
+
+=cut
+
 # GstEvent * gst_event_new_buffer_size (GstFormat format, gint64 minsize, gint64 maxsize, gboolean async);
 GstEvent_noinc *
 new (class, GstFormat format, gint64 minsize, gint64 maxsize, gboolean async)
@@ -361,6 +393,10 @@ format (GstEvent *event)
 
 MODULE = GStreamer::Event      PACKAGE = GStreamer::Event::QOS
 
+=for object GStreamer::Event::QOS Structure describing events that are passed up and down a pipeline
+
+=cut
+
 # GstEvent * gst_event_new_qos (gdouble proportion, GstClockTimeDiff diff, GstClockTime timestamp);
 GstEvent_noinc *
 new (class, gdouble proportion, GstClockTimeDiff diff, GstClockTime timestamp)
@@ -404,6 +440,10 @@ proportion (GstEvent *event)
 
 MODULE = GStreamer::Event      PACKAGE = GStreamer::Event::Seek
 
+=for object GStreamer::Event::Seek Structure describing events that are passed up and down a pipeline
+
+=cut
+
 # GstEvent * gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags, GstSeekType cur_type, 
gint64 cur, GstSeekType stop_type, gint64 stop);
 GstEvent_noinc *
 new (class, gdouble rate, GstFormat format, GstSeekFlags flags, GstSeekType cur_type, gint64 cur, 
GstSeekType stop_type, gint64 stop)
@@ -468,6 +508,10 @@ rate (GstEvent *event)
 
 MODULE = GStreamer::Event      PACKAGE = GStreamer::Event::Navigation
 
+=for object GStreamer::Event::Navigation Structure describing events that are passed up and down a pipeline
+
+=cut
+
 # GstEvent * gst_event_new_navigation (GstStructure *structure);
 GstEvent_noinc *
 new (class, GstStructure *structure)
diff --git a/xs/GstFormat.xs b/xs/GstFormat.xs
index 9ffdb71..13916b7 100644
--- a/xs/GstFormat.xs
+++ b/xs/GstFormat.xs
@@ -57,6 +57,10 @@ SvGstFormat (SV *sv)
 
 MODULE = GStreamer::Format     PACKAGE = GStreamer::Format     PREFIX = gst_format_
 
+=for object GStreamer::Format Dynamically register new data formats
+
+=cut
+
 =for apidoc __function__
 =cut
 # GstFormat gst_format_register (const gchar *nick, const gchar *description);
diff --git a/xs/GstGhostPad.xs b/xs/GstGhostPad.xs
index bccf191..b9c44e5 100644
--- a/xs/GstGhostPad.xs
+++ b/xs/GstGhostPad.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::GhostPad   PACKAGE = GStreamer::GhostPad   PREFIX = gst_ghost_pad_
 
+=for object GStreamer::GhostPad Pseudo link pads
+
+=cut
+
 # GstPad * gst_ghost_pad_new (const gchar *name, GstPad *target);
 GstPad_ornull * gst_ghost_pad_new (class, const gchar_ornull *name, GstPad *target)
     C_ARGS:
diff --git a/xs/GstIndex.xs b/xs/GstIndex.xs
index d88c968..5cd8d0b 100644
--- a/xs/GstIndex.xs
+++ b/xs/GstIndex.xs
@@ -129,6 +129,10 @@ gst2perl_index_resolver (GstIndex *index,
 
 MODULE = GStreamer::Index      PACKAGE = GStreamer::Index      PREFIX = gst_index_
 
+=for object GStreamer::Index Generate indexes on objects
+
+=cut
+
 # GstIndex * gst_index_new (void);
 GstIndex *
 gst_index_new (class)
@@ -254,6 +258,10 @@ GstIndexEntry_ornull * gst_index_get_assoc_entry (GstIndex *index, gint id, GstI
 
 MODULE = GStreamer::Index      PACKAGE = GStreamer::IndexEntry PREFIX = gst_index_entry_
 
+=for object GStreamer::IndexEntry Generate indexes on objects
+
+=cut
+
 # gboolean gst_index_entry_assoc_map (GstIndexEntry *entry, GstFormat format, gint64 *value);
 gint64
 gst_index_entry_assoc_map (entry, format)
diff --git a/xs/GstIndexFactory.xs b/xs/GstIndexFactory.xs
index abb188b..7060f86 100644
--- a/xs/GstIndexFactory.xs
+++ b/xs/GstIndexFactory.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::IndexFactory       PACKAGE = GStreamer::IndexFactory       PREFIX = gst_index_factory_
 
+=for object GStreamer::IndexFactory Create GstIndexes from a factory
+
+=cut
+
 # GstIndexFactory * gst_index_factory_new (const gchar *name, const gchar *longdesc, GType type);
 GstIndexFactory *
 gst_index_factory_new (class, name, longdesc, type)
diff --git a/xs/GstIterator.xs b/xs/GstIterator.xs
index a4238f8..78e2dcc 100644
--- a/xs/GstIterator.xs
+++ b/xs/GstIterator.xs
@@ -100,6 +100,10 @@ SV * sv_from_pointer (gpointer pointer, GType gtype, gboolean own)
 
 MODULE = GStreamer::Iterator   PACKAGE = GStreamer::Iterator   PREFIX = gst_iterator_
 
+=for object GStreamer::Iterator Object to retrieve multiple elements in a threadsafe way.
+
+=cut
+
 =for position SYNOPSIS
 
 =head1 SYNOPSIS
@@ -187,6 +191,10 @@ gst_iterator_next (iter)
 
 MODULE = GStreamer::Iterator   PACKAGE = GStreamer::Iterator::Tie
 
+=for object GStreamer::Iterator::Tie Object to retrieve multiple elements in a threadsafe way.
+
+=cut
+
 IV
 FETCHSIZE (GstIterator *iter)
     PREINIT:
diff --git a/xs/GstMessage.xs b/xs/GstMessage.xs
index 16895ba..5782304 100644
--- a/xs/GstMessage.xs
+++ b/xs/GstMessage.xs
@@ -132,6 +132,10 @@ get_package (GstMessage *message)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message    PREFIX = gst_message_
 
+=for object GStreamer::Message Lightweight objects to signal the application of pipeline events
+
+=cut
+
 BOOT:
        gperl_set_isa ("GStreamer::Message::EOS", "GStreamer::Message");
        gperl_set_isa ("GStreamer::Message::Error", "GStreamer::Message");
@@ -274,6 +278,10 @@ src (GstMessage *message)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::Custom
 
+=for object GStreamer::Message::Custom Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_custom (GstMessageType type, GstObject * src, GstStructure * structure);
 GstMessage_noinc *
 new (class, GstMessageType type, GstObject * src, GstStructure * structure)
@@ -287,6 +295,10 @@ new (class, GstMessageType type, GstObject * src, GstStructure * structure)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::EOS
 
+=for object GStreamer::Message::EOS Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_eos (GstObject * src);
 GstMessage_noinc *
 new (class, GstObject * src)
@@ -299,6 +311,10 @@ new (class, GstObject * src)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::Error
 
+=for object GStreamer::Message::Error Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_error (GstObject * src, GError * error, gchar * debug);
 GstMessage_noinc *
 new (class, GstObject * src, SV * error, gchar * debug)
@@ -342,6 +358,10 @@ error (GstMessage *message)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::Warning
 
+=for object GStreamer::Message::Warning Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_warning (GstObject * src, GError * error, gchar * debug);
 GstMessage_noinc *
 new (class, GstObject * src, SV * error, gchar * debug)
@@ -385,6 +405,10 @@ error (GstMessage *message)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::Tag
 
+=for object GStreamer::Message::Tag Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_tag (GstObject * src, GstTagList * tag_list);
 GstMessage_noinc *
 new (class, GstObject * src, GstTagList * tag_list)
@@ -407,6 +431,10 @@ tag_list (GstMessage *message)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::StateChanged
 
+=for object GStreamer::Message::StateChanged Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_state_changed (GstObject * src, GstState oldstate, GstState newstate, 
GstState pending);
 GstMessage_noinc *
 new (class, GstObject * src, GstState oldstate, GstState newstate, GstState pending)
@@ -439,6 +467,10 @@ old_state (GstMessage *message)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::StateDirty
 
+=for object GStreamer::Message::StateDirty Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_state_dirty (GstObject * src);
 GstMessage_noinc *
 new (class, GstObject * src)
@@ -451,6 +483,10 @@ new (class, GstObject * src)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::ClockProvide
 
+=for object GStreamer::Message::ClockProvide Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_clock_provide (GstObject * src, GstClock *clock, gboolean ready);
 GstMessage_noinc *
 new (class, GstObject * src, GstClock * clock, gboolean ready)
@@ -489,6 +525,10 @@ clock (GstMessage *message)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::ClockLost
 
+=for object GStreamer::Message::ClockLost Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_clock_lost (GstObject * src, GstClock *clock);
 GstMessage_noinc *
 new (class, GstObject * src, GstClock * clock)
@@ -510,6 +550,10 @@ clock (GstMessage *message)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::NewClock
 
+=for object GStreamer::Message::NewClock Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_new_clock (GstObject * src, GstClock *clock);
 GstMessage_noinc *
 new (class, GstObject * src, GstClock * clock)
@@ -531,6 +575,10 @@ clock (GstMessage *message)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::Application
 
+=for object GStreamer::Message::Application Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_application (GstObject * src, GstStructure * structure);
 GstMessage_noinc *
 new (class, GstObject * src, GstStructure * structure)
@@ -544,6 +592,10 @@ new (class, GstObject * src, GstStructure * structure)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::Element
 
+=for object GStreamer::Message::Element Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_element (GstObject * src, GstStructure * structure);
 GstMessage_noinc *
 new (class, GstObject * src, GstStructure * structure)
@@ -557,6 +609,10 @@ new (class, GstObject * src, GstStructure * structure)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::SegmentStart
 
+=for object GStreamer::Message::SegmentStart Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_segment_start (GstObject * src, GstFormat format, gint64 position);
 GstMessage_noinc *
 new (class, GstObject * src, GstFormat format, gint64 position)
@@ -595,6 +651,10 @@ format (GstMessage *message)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::SegmentDone
 
+=for object GStreamer::Message::SegmentDone Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_segment_done (GstObject * src, GstFormat format, gint64 position);
 GstMessage_noinc *
 new (class, GstObject * src, GstFormat format, gint64 position)
@@ -633,6 +693,10 @@ format (GstMessage *message)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::Duration
 
+=for object GStreamer::Message::Duration Lightweight objects to signal the application of pipeline events
+
+=cut
+
 # GstMessage * gst_message_new_duration (GstObject * src, GstFormat format, gint64 duration);
 GstMessage_noinc *
 new (class, GstObject * src, GstFormat format, gint64 duration)
@@ -671,6 +735,10 @@ format (GstMessage *message)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::Latency
 
+=for object GStreamer::Message::Latency Lightweight objects to signal the application of pipeline events
+
+=cut
+
 #if GST_CHECK_VERSION (0, 10, 12)
 
 # GstMessage * gst_message_new_latency (GstObject * src);
@@ -687,6 +755,10 @@ new (class, GstObject * src)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::AsyncStart
 
+=for object GStreamer::Message::AsyncStart Lightweight objects to signal the application of pipeline events
+
+=cut
+
 #if GST_CHECK_VERSION (0, 10, 13)
 
 # GstMessage * gst_message_new_async_start (GstObject * src, gboolean new_base_time);
@@ -712,6 +784,10 @@ new_base_time (GstMessage *message)
 
 MODULE = GStreamer::Message    PACKAGE = GStreamer::Message::AsyncDone
 
+=for object GStreamer::Message::AsyncDone Lightweight objects to signal the application of pipeline events
+
+=cut
+
 #if GST_CHECK_VERSION (0, 10, 13)
 
 # GstMessage * gst_message_new_async_done (GstObject * src);
diff --git a/xs/GstMiniObject.xs b/xs/GstMiniObject.xs
index caba335..9ba9774 100644
--- a/xs/GstMiniObject.xs
+++ b/xs/GstMiniObject.xs
@@ -151,6 +151,10 @@ gst2perl_mini_object_initialize (void)
 
 MODULE = GStreamer::MiniObject PACKAGE = GStreamer::MiniObject PREFIX = gst_mini_object_
 
+=for object GStreamer::MiniObject Lightweight base class for the GStreamer object hierarchy
+
+=cut
+
 BOOT:
        gst2perl_mini_object_initialize ();
 
diff --git a/xs/GstObject.xs b/xs/GstObject.xs
index 1e36eb1..24f55d8 100644
--- a/xs/GstObject.xs
+++ b/xs/GstObject.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::Object     PACKAGE = GStreamer::Object     PREFIX = gst_object_
 
+=for object GStreamer::Object Base class for the GStreamer object hierarchy
+
+=cut
+
 BOOT:
        /* Register gst_object_sink() as the sink function to get the
           ref-counting right. */
diff --git a/xs/GstPad.xs b/xs/GstPad.xs
index dc8b168..cecd70b 100644
--- a/xs/GstPad.xs
+++ b/xs/GstPad.xs
@@ -40,6 +40,10 @@ gst2perl_task_func (gpointer data)
 
 MODULE = GStreamer::Pad        PACKAGE = GStreamer::Pad        PREFIX = gst_pad_
 
+=for object GStreamer::Pad Object contained by elements that allows links to other elements
+
+=cut
+
 BOOT:
        gperl_object_set_no_warn_unreg_subclass (GST_TYPE_PAD, TRUE);
 
diff --git a/xs/GstPadTemplate.xs b/xs/GstPadTemplate.xs
index c5c6760..d870bdc 100644
--- a/xs/GstPadTemplate.xs
+++ b/xs/GstPadTemplate.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::PadTemplate        PACKAGE = GStreamer::PadTemplate        PREFIX = gst_pad_template_
 
+=for object GStreamer::PadTemplate Describe the media type of a pad.
+
+=cut
+
 # GstPadTemplate* gst_pad_template_new (const gchar *name_template, GstPadDirection direction, 
GstPadPresence presence, GstCaps *caps);
 GstPadTemplate *
 gst_pad_template_new (class, name_template, direction, presence, caps)
diff --git a/xs/GstPipeline.xs b/xs/GstPipeline.xs
index 45fc4ad..033fb3b 100644
--- a/xs/GstPipeline.xs
+++ b/xs/GstPipeline.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::Pipeline   PACKAGE = GStreamer::Pipeline   PREFIX = gst_pipeline_
 
+=for object GStreamer::Pipeline Top-level bin with clocking and bus management functionality.
+
+=cut
+
 BOOT:
        gperl_object_set_no_warn_unreg_subclass (GST_TYPE_PIPELINE, TRUE);
 
diff --git a/xs/GstPlugin.xs b/xs/GstPlugin.xs
index 519269f..96fe678 100644
--- a/xs/GstPlugin.xs
+++ b/xs/GstPlugin.xs
@@ -62,6 +62,10 @@ gst2perl_plugin_filter (GstPlugin *plugin,
 
 MODULE = GStreamer::Plugin     PACKAGE = GStreamer::Plugin     PREFIX = gst_plugin_
 
+=for object GStreamer::Plugin Container for features loaded from a shared object module
+
+=cut
+
 const gchar* gst_plugin_get_name (GstPlugin *plugin);
 
 const gchar* gst_plugin_get_description (GstPlugin *plugin);
diff --git a/xs/GstPluginFeature.xs b/xs/GstPluginFeature.xs
index f95767f..14f5ca6 100644
--- a/xs/GstPluginFeature.xs
+++ b/xs/GstPluginFeature.xs
@@ -54,6 +54,10 @@ gst2perl_plugin_feature_filter (GstPluginFeature *feature,
 
 MODULE = GStreamer::PluginFeature      PACKAGE = GStreamer::PluginFeature      PREFIX = gst_plugin_feature_
 
+=for object GStreamer::PluginFeature Base class for contents of a GstPlugin
+
+=cut
+
 BOOT:
        gperl_object_set_no_warn_unreg_subclass (GST_TYPE_PLUGIN_FEATURE, TRUE);
 
diff --git a/xs/GstQuery.xs b/xs/GstQuery.xs
index d11d184..80cbc4b 100644
--- a/xs/GstQuery.xs
+++ b/xs/GstQuery.xs
@@ -108,6 +108,10 @@ get_package (GstQuery *query)
 
 MODULE = GStreamer::Query      PACKAGE = GStreamer::QueryType  PREFIX = gst_query_type_
 
+=for object GStreamer::QueryType Dynamically register new query types. Provide functions to create queries, 
and to set and parse values in them.
+
+=cut
+
 BOOT:
        gst2perl_register_mini_object_package_lookup_func (
                GST_TYPE_QUERY,
@@ -155,6 +159,10 @@ gst_query_type_get_details (type)
 
 MODULE = GStreamer::Query      PACKAGE = GStreamer::Query      PREFIX = gst_query_
 
+=for object GStreamer::Query Dynamically register new query types. Provide functions to create queries, and 
to set and parse values in them.
+
+=cut
+
 BOOT:
        gperl_set_isa ("GStreamer::Query::Position", "GStreamer::Query");
        gperl_set_isa ("GStreamer::Query::Duration", "GStreamer::Query");
@@ -217,6 +225,10 @@ GstStructure * gst_query_get_structure (GstQuery *query);
 
 MODULE = GStreamer::Query      PACKAGE = GStreamer::Query::Position
 
+=for object GStreamer::Query::Position Dynamically register new query types. Provide functions to create 
queries, and to set and parse values in them.
+
+=cut
+
 # GstQuery* gst_query_new_position (GstFormat format);
 GstQuery_noinc *
 new (class, GstFormat format)
@@ -244,6 +256,10 @@ position (GstQuery *query, GstFormat format=0, gint64 cur=0)
 
 MODULE = GStreamer::Query      PACKAGE = GStreamer::Query::Duration
 
+=for object GStreamer::Query::Duration Dynamically register new query types. Provide functions to create 
queries, and to set and parse values in them.
+
+=cut
+
 # GstQuery* gst_query_new_duration (GstFormat format);
 GstQuery_noinc *
 new (class, GstFormat format)
@@ -271,6 +287,10 @@ duration (GstQuery *query, GstFormat format=0, gint64 duration=0)
 
 MODULE = GStreamer::Query      PACKAGE = GStreamer::Query::Convert
 
+=for object GStreamer::Query::Convert Dynamically register new query types. Provide functions to create 
queries, and to set and parse values in them.
+
+=cut
+
 # GstQuery* gst_query_new_convert (GstFormat src_format, gint64 value, GstFormat dest_format);
 GstQuery_noinc *
 new (class, GstFormat src_format, gint64 value, GstFormat dest_format)
@@ -302,6 +322,10 @@ convert (GstQuery *query, GstFormat src_format=0, gint64 src_value=0, GstFormat
 
 MODULE = GStreamer::Query      PACKAGE = GStreamer::Query::Segment
 
+=for object GStreamer::Query::Segment Dynamically register new query types. Provide functions to create 
queries, and to set and parse values in them.
+
+=cut
+
 # GstQuery* gst_query_new_segment (GstFormat format);
 GstQuery_noinc *
 new (class, GstFormat format)
@@ -333,6 +357,10 @@ segment (GstQuery *query, gdouble rate=0.0, GstFormat format=0, gint64 start_val
 
 MODULE = GStreamer::Query      PACKAGE = GStreamer::Query::Application
 
+=for object GStreamer::Query::Application Dynamically register new query types. Provide functions to create 
queries, and to set and parse values in them.
+
+=cut
+
 # GstQuery * gst_query_new_application (GstQueryType type, GstStructure *structure);
 GstQuery_noinc *
 new (class, GstQueryType type, GstStructure *structure)
diff --git a/xs/GstRegistry.xs b/xs/GstRegistry.xs
index f580670..bc94cb8 100644
--- a/xs/GstRegistry.xs
+++ b/xs/GstRegistry.xs
@@ -41,6 +41,10 @@ extern gboolean gst2perl_plugin_feature_filter (GstPluginFeature *feature, gpoin
 
 MODULE = GStreamer::Registry   PACKAGE = GStreamer::Registry   PREFIX = gst_registry_
 
+=for object GStreamer::Registry Abstract base class for management of GstPlugin objects
+
+=cut
+
 BOOT:
        gperl_object_set_no_warn_unreg_subclass (GST_TYPE_REGISTRY, TRUE);
 
diff --git a/xs/GstStructure.xs b/xs/GstStructure.xs
index b2c17df..a831272 100644
--- a/xs/GstStructure.xs
+++ b/xs/GstStructure.xs
@@ -146,6 +146,10 @@ newSVGstStructure (const GstStructure *structure)
 
 MODULE = GStreamer::Structure  PACKAGE = GStreamer::Structure  PREFIX = gst_structure_
 
+=for object GStreamer::Structure Generic structure containing fields of names and values
+
+=cut
+
 =for position SYNOPSIS
 
 =head1 SYNOPSIS
diff --git a/xs/GstSystemClock.xs b/xs/GstSystemClock.xs
index 885d88f..583d1d2 100644
--- a/xs/GstSystemClock.xs
+++ b/xs/GstSystemClock.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::SystemClock        PACKAGE = GStreamer::SystemClock        PREFIX = gst_system_clock_
 
+=for object GStreamer::SystemClock Default clock that uses the current system time
+
+=cut
+
 BOOT:
        gperl_object_set_no_warn_unreg_subclass (GST_TYPE_SYSTEM_CLOCK, TRUE);
 
diff --git a/xs/GstTag.xs b/xs/GstTag.xs
index a862662..28bea29 100644
--- a/xs/GstTag.xs
+++ b/xs/GstTag.xs
@@ -115,6 +115,10 @@ gst_tag_list_unwrap (GType gtype,
 
 MODULE = GStreamer::Tag        PACKAGE = GStreamer::Tag        PREFIX = gst_tag_
 
+=for object GStreamer::Tag Element interface for media metadata
+
+=cut
+
 BOOT:
        gst_tag_list_wrapper_class = *gperl_default_boxed_wrapper_class ();
        gst_tag_list_wrapper_class.wrap = (GPerlBoxedWrapFunc) gst_tag_list_wrap;
diff --git a/xs/GstTagSetter.xs b/xs/GstTagSetter.xs
index be6d007..a9dd4f1 100644
--- a/xs/GstTagSetter.xs
+++ b/xs/GstTagSetter.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::TagSetter  PACKAGE = GStreamer::TagSetter  PREFIX = gst_tag_setter_
 
+=for object GStreamer::TagSetter Element interface that allows setting and retrieval of media metadata
+
+=cut
+
 void gst_tag_setter_merge_tags (GstTagSetter *setter, const GstTagList *list, GstTagMergeMode mode);
 
 # void gst_tag_setter_add_tags (GstTagSetter *setter, GstTagMergeMode mode, const gchar *tag, ...);
diff --git a/xs/GstTypeFindFactory.xs b/xs/GstTypeFindFactory.xs
index e424590..6ca1f75 100644
--- a/xs/GstTypeFindFactory.xs
+++ b/xs/GstTypeFindFactory.xs
@@ -23,6 +23,10 @@
 
 MODULE = GStreamer::TypeFindFactory    PACKAGE = GStreamer::TypeFindFactory    PREFIX = 
gst_type_find_factory_
 
+=for object GStreamer::TypeFindFactory Information about registered typefind functions
+
+=cut
+
 # GList * gst_type_find_factory_get_list (void);
 void
 gst_type_find_factory_get_list (class)
diff --git a/xs/GstValue.xs b/xs/GstValue.xs
index a7037ed..35f2a8c 100644
--- a/xs/GstValue.xs
+++ b/xs/GstValue.xs
@@ -484,6 +484,10 @@ gst2perl_date_initialize (void)
 
 MODULE = GStreamer::Value      PACKAGE = GStreamer::Value      PREFIX = gst_value_
 
+=for object GStreamer::Value GValue implementations specific to GStreamer
+
+=cut
+
 BOOT:
        gst2perl_fourcc_initialize ();
        gst2perl_int_range_initialize ();
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]