[gstreamermm] docs: update doc, remove some todos



commit 029aa9a6413a04593dffe27edb2aad56924ef85d
Author: Marcin Kolny <marcin kolny gmail com>
Date:   Sat Aug 27 15:50:23 2016 +0200

    docs: update doc, remove some todos

 gstreamer/src/basesrc.hg |   35 +++++++++++++++++++++++++----------
 gstreamer/src/bus.hg     |    2 --
 gstreamer/src/plugin.hg  |    2 --
 3 files changed, 25 insertions(+), 14 deletions(-)
---
diff --git a/gstreamer/src/basesrc.hg b/gstreamer/src/basesrc.hg
index 52181d1..adc7722 100644
--- a/gstreamer/src/basesrc.hg
+++ b/gstreamer/src/basesrc.hg
@@ -32,12 +32,13 @@ namespace Gst
 _WRAP_ENUM(BaseSrcFlags, GstBaseSrcFlags, NO_GTYPE)
 
 /** A base class for getrange based source elements.
+ *
  * This is a generice base class for source elements. The following types of
  * sources are supported:
  *
- *- random access sources like files
- *- seekable sources
- *- live sources
+ * - random access sources like files,
+ * - seekable sources,
+ * - live sources.
  *
  * The source can be configured to operate in any Gst::Format with the
  * set_format() method. The currently set format determines the format of the
@@ -47,8 +48,8 @@ _WRAP_ENUM(BaseSrcFlags, GstBaseSrcFlags, NO_GTYPE)
  * Gst::BaseSrc always supports push mode scheduling. If the following
  * conditions are met, it also supports pull mode scheduling:
  *
- *     - The format is set to Gst::FORMAT_BYTES (default).
- *     - Gst::BaseSrc::is_seekable_vfunc() returns TRUE.
+ * - The format is set to Gst::FORMAT_BYTES (default).
+ * - Gst::BaseSrc::is_seekable_vfunc() returns TRUE.
  *
  * Since GStreamer 0.10.9, any Gst::BaseSrc can enable pull based scheduling at
  * any time by overriding Gst::BaseSrc::check_get_range_vfunc() so that it
@@ -59,11 +60,11 @@ _WRAP_ENUM(BaseSrcFlags, GstBaseSrcFlags, NO_GTYPE)
  * be met to make the element seekable in push mode when the format is not
  * Gst::FORMAT_BYTES:
  *
- *     - Gst::BaseSrc::is_seekable_vfunc() returns TRUE.
- *     - Gst::BaseSrc::query_vfunc() can convert all supported seek formats to
- *     the internal format as set with set_format().
- *     - Gst::BaseSrc::do_seek_vfunc() is implemented, performs the seek and
- *     returns TRUE.
+ * - Gst::BaseSrc::is_seekable_vfunc() returns TRUE.
+ * - Gst::BaseSrc::query_vfunc() can convert all supported seek formats to
+ * the internal format as set with set_format().
+ * - Gst::BaseSrc::do_seek_vfunc() is implemented, performs the seek and
+ * returns TRUE.
  *
  * When the element does not meet the requirements to operate in pull mode, the
  * offset and length in the Gst::BaseSrc::create_vfunc() method should be
@@ -112,6 +113,20 @@ _WRAP_ENUM(BaseSrcFlags, GstBaseSrcFlags, NO_GTYPE)
  * There is only support in Gst::BaseSrc for exactly one source pad, which
  * should be named "src". A source implementation (subclass of Gst::BaseSrc)
  * should install a pad template in its class_init function, like so:
+ * @code
+ * // static
+ * void SampleBaseSrc::base_init(Gst::ElementClass<SampleBaseSrc> *klass)
+ * {
+ *   klass->add_pad_template(Gst::PadTemplate::create(
+ *                                 "src",
+ *                                 Gst::PAD_SRC,
+ *                                 Gst::PAD_ALWAYS,
+ *                                 Gst::Caps::create_from_string("x-application/x-foo1")
+ *   ));
+ *
+ *   klass->set_metadata("Source name", "Source", "My source element", "The author <my.sink@my.email>");
+ * }
+ * @endcode
  *
  * <H2>Controlled shutdown of live sources in applications</H2>
  *
diff --git a/gstreamer/src/bus.hg b/gstreamer/src/bus.hg
index ed003a5..dadb5bd 100644
--- a/gstreamer/src/bus.hg
+++ b/gstreamer/src/bus.hg
@@ -46,8 +46,6 @@ _WRAP_ENUM(BusSyncReply, GstBusSyncReply)
  * The Gst::Bus provides support for GSource based notifications. This makes it
  * possible to handle the delivery in the glib mainloop.
  *
- * TODO: Correct C API reference in following paragraph:
- *
  * The GSource callback function gst_bus_async_signal_func() can be used to
  * convert all bus messages into signal emissions.
  *
diff --git a/gstreamer/src/plugin.hg b/gstreamer/src/plugin.hg
index 901c58e..d6dc133 100644
--- a/gstreamer/src/plugin.hg
+++ b/gstreamer/src/plugin.hg
@@ -44,8 +44,6 @@ class Structure;
  * A plugin system can provide one or more of the basic GStreamer
  * Gst::PluginFeature subclasses.
  *
- * TODO: Edit following paragraph to use gstreamermm classes/methods:
- *
  * A plugin should export a symbol gst_plugin_desc that is a struct of type
  * PluginDesc. the plugin loader will check the version of the core library
  * the plugin was linked against and will create a new Gst::Plugin. It will


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]