[gstreamermm] Remove initial class identification in Doxygen class docs.
- From: José Alburquerque <jaalburqu src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gstreamermm] Remove initial class identification in Doxygen class docs.
- Date: Mon, 1 Feb 2010 22:42:35 +0000 (UTC)
commit 92d228f21e2f75f559a3ebff8969811bc9c2d411
Author: José Alburquerque <jaalburqu svn gnome org>
Date: Mon Feb 1 17:37:42 2010 -0500
Remove initial class identification in Doxygen class docs.
* gstreamer/src/audioclock.hg:
* gstreamer/src/audiofilter.hg:
* gstreamer/src/audiosink.hg:
* gstreamer/src/audiosrc.hg:
* gstreamer/src/baseaudiosink.hg:
* gstreamer/src/baseaudiosrc.hg:
* gstreamer/src/basesink.hg:
* gstreamer/src/basesrc.hg:
* gstreamer/src/basetransform.hg:
* gstreamer/src/bin.hg:
* gstreamer/src/buffer.hg:
* gstreamer/src/bus.hg:
* gstreamer/src/caps.hg:
* gstreamer/src/cddabasesrc.hg:
* gstreamer/src/childproxy.hg:
* gstreamer/src/clock.hg:
* gstreamer/src/colorbalance.hg:
* gstreamer/src/colorbalancechannel.hg:
* gstreamer/src/element.hg:
* gstreamer/src/elementfactory.hg:
* gstreamer/src/error.hg:
* gstreamer/src/event.hg:
* gstreamer/src/filter.hg:
* gstreamer/src/format.hg:
* gstreamer/src/ghostpad.hg:
* gstreamer/src/index.hg:
* gstreamer/src/indexfactory.hg:
* gstreamer/src/interface.hg:
* gstreamer/src/iterator.hg:
* gstreamer/src/message.hg:
* gstreamer/src/mixer.hg:
* gstreamer/src/mixeroptions.hg:
* gstreamer/src/mixertrack.hg:
* gstreamer/src/navigation.hg:
* gstreamer/src/object.hg:
* gstreamer/src/pad.hg:
* gstreamer/src/padtemplate.hg:
* gstreamer/src/parse.hg:
* gstreamer/src/pipeline.hg:
* gstreamer/src/plugin.hg:
* gstreamer/src/pluginfeature.hg:
* gstreamer/src/preset.hg:
* gstreamer/src/propertyprobe.hg:
* gstreamer/src/pushsrc.hg:
* gstreamer/src/query.hg:
* gstreamer/src/registry.hg:
* gstreamer/src/ringbuffer.hg:
* gstreamer/src/segment.hg:
* gstreamer/src/streamvolume.hg:
* gstreamer/src/structure.hg:
* gstreamer/src/systemclock.hg:
* gstreamer/src/taglist.hg:
* gstreamer/src/tagsetter.hg:
* gstreamer/src/task.hg:
* gstreamer/src/taskpool.hg:
* gstreamer/src/tuner.hg:
* gstreamer/src/tunerchannel.hg:
* gstreamer/src/tunernorm.hg:
* gstreamer/src/typefind.hg:
* gstreamer/src/typefindfactory.hg:
* gstreamer/src/urihandler.hg:
* gstreamer/src/value.hg:
* gstreamer/src/videoorientation.hg:
* gstreamer/src/videosink.hg:
* gstreamer/src/xml.hg:
* gstreamer/src/xoverlay.hg: Remove initial class identification in
Doxygen docs of classes and plug-ins because it looks redundant in the
documentation.
* tools/extra_defs_gen/generate_plugin_gmmproc_file.cc: Correct help
information that is printed at the command line with the '-?' option.
ChangeLog | 75 +++++++++++
gstreamer/src/audioclock.hg | 2 +-
gstreamer/src/audiofilter.hg | 2 +-
gstreamer/src/audiosink.hg | 2 +-
gstreamer/src/audiosrc.hg | 2 +-
gstreamer/src/baseaudiosink.hg | 2 +-
gstreamer/src/baseaudiosrc.hg | 2 +-
gstreamer/src/basesink.hg | 2 +-
gstreamer/src/basesrc.hg | 2 +-
gstreamer/src/basetransform.hg | 16 ++--
gstreamer/src/bin.hg | 2 +-
gstreamer/src/buffer.hg | 2 +-
gstreamer/src/bus.hg | 2 +-
gstreamer/src/caps.hg | 21 ++--
gstreamer/src/cddabasesrc.hg | 2 +-
gstreamer/src/childproxy.hg | 2 +-
gstreamer/src/clock.hg | 33 +++---
gstreamer/src/colorbalance.hg | 2 +-
gstreamer/src/colorbalancechannel.hg | 2 +-
gstreamer/src/element.hg | 4 +-
gstreamer/src/elementfactory.hg | 2 +-
gstreamer/src/error.hg | 16 ++--
gstreamer/src/event.hg | 7 +-
gstreamer/src/filter.hg | 2 +-
gstreamer/src/format.hg | 21 ++--
gstreamer/src/ghostpad.hg | 2 +-
gstreamer/src/index.hg | 3 +-
gstreamer/src/indexfactory.hg | 2 +-
gstreamer/src/interface.hg | 4 +-
gstreamer/src/iterator.hg | 11 +-
gstreamer/src/message.hg | 8 +-
gstreamer/src/mixer.hg | 2 +-
gstreamer/src/mixeroptions.hg | 2 +-
gstreamer/src/mixertrack.hg | 3 +-
gstreamer/src/navigation.hg | 3 +-
gstreamer/src/object.hg | 2 +-
gstreamer/src/pad.hg | 4 +-
gstreamer/src/padtemplate.hg | 2 +-
gstreamer/src/parse.hg | 2 +-
gstreamer/src/pipeline.hg | 12 +-
gstreamer/src/plugin.hg | 4 +-
gstreamer/src/pluginfeature.hg | 2 +-
gstreamer/src/preset.hg | 2 +-
gstreamer/src/propertyprobe.hg | 2 +-
gstreamer/src/pushsrc.hg | 2 +-
gstreamer/src/query.hg | 8 +-
gstreamer/src/registry.hg | 2 +-
gstreamer/src/ringbuffer.hg | 7 +-
gstreamer/src/segment.hg | 3 +-
gstreamer/src/streamvolume.hg | 2 +-
gstreamer/src/structure.hg | 2 +-
gstreamer/src/systemclock.hg | 2 +-
gstreamer/src/taglist.hg | 130 ++++++++++---------
gstreamer/src/tagsetter.hg | 4 +-
gstreamer/src/task.hg | 2 +-
gstreamer/src/taskpool.hg | 2 +-
gstreamer/src/tuner.hg | 2 +-
gstreamer/src/tunerchannel.hg | 3 +-
gstreamer/src/tunernorm.hg | 2 +-
gstreamer/src/typefind.hg | 2 +-
gstreamer/src/typefindfactory.hg | 6 +-
gstreamer/src/urihandler.hg | 2 +-
gstreamer/src/value.hg | 10 +-
gstreamer/src/videoorientation.hg | 3 +-
gstreamer/src/videosink.hg | 6 +-
gstreamer/src/xml.hg | 2 +-
gstreamer/src/xoverlay.hg | 3 +-
.../extra_defs_gen/generate_plugin_gmmproc_file.cc | 18 ++--
68 files changed, 301 insertions(+), 223 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index c7c106f..de8f63b 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,78 @@
+2010-02-01 José Alburquerque <jaalburqu svn gnome org>
+
+ Remove initial class identification in Doxygen class docs.
+
+ * gstreamer/src/audioclock.hg:
+ * gstreamer/src/audiofilter.hg:
+ * gstreamer/src/audiosink.hg:
+ * gstreamer/src/audiosrc.hg:
+ * gstreamer/src/baseaudiosink.hg:
+ * gstreamer/src/baseaudiosrc.hg:
+ * gstreamer/src/basesink.hg:
+ * gstreamer/src/basesrc.hg:
+ * gstreamer/src/basetransform.hg:
+ * gstreamer/src/bin.hg:
+ * gstreamer/src/buffer.hg:
+ * gstreamer/src/bus.hg:
+ * gstreamer/src/caps.hg:
+ * gstreamer/src/cddabasesrc.hg:
+ * gstreamer/src/childproxy.hg:
+ * gstreamer/src/clock.hg:
+ * gstreamer/src/colorbalance.hg:
+ * gstreamer/src/colorbalancechannel.hg:
+ * gstreamer/src/element.hg:
+ * gstreamer/src/elementfactory.hg:
+ * gstreamer/src/error.hg:
+ * gstreamer/src/event.hg:
+ * gstreamer/src/filter.hg:
+ * gstreamer/src/format.hg:
+ * gstreamer/src/ghostpad.hg:
+ * gstreamer/src/index.hg:
+ * gstreamer/src/indexfactory.hg:
+ * gstreamer/src/interface.hg:
+ * gstreamer/src/iterator.hg:
+ * gstreamer/src/message.hg:
+ * gstreamer/src/mixer.hg:
+ * gstreamer/src/mixeroptions.hg:
+ * gstreamer/src/mixertrack.hg:
+ * gstreamer/src/navigation.hg:
+ * gstreamer/src/object.hg:
+ * gstreamer/src/pad.hg:
+ * gstreamer/src/padtemplate.hg:
+ * gstreamer/src/parse.hg:
+ * gstreamer/src/pipeline.hg:
+ * gstreamer/src/plugin.hg:
+ * gstreamer/src/pluginfeature.hg:
+ * gstreamer/src/preset.hg:
+ * gstreamer/src/propertyprobe.hg:
+ * gstreamer/src/pushsrc.hg:
+ * gstreamer/src/query.hg:
+ * gstreamer/src/registry.hg:
+ * gstreamer/src/ringbuffer.hg:
+ * gstreamer/src/segment.hg:
+ * gstreamer/src/streamvolume.hg:
+ * gstreamer/src/structure.hg:
+ * gstreamer/src/systemclock.hg:
+ * gstreamer/src/taglist.hg:
+ * gstreamer/src/tagsetter.hg:
+ * gstreamer/src/task.hg:
+ * gstreamer/src/taskpool.hg:
+ * gstreamer/src/tuner.hg:
+ * gstreamer/src/tunerchannel.hg:
+ * gstreamer/src/tunernorm.hg:
+ * gstreamer/src/typefind.hg:
+ * gstreamer/src/typefindfactory.hg:
+ * gstreamer/src/urihandler.hg:
+ * gstreamer/src/value.hg:
+ * gstreamer/src/videoorientation.hg:
+ * gstreamer/src/videosink.hg:
+ * gstreamer/src/xml.hg:
+ * gstreamer/src/xoverlay.hg: Remove initial class identification in
+ Doxygen docs of classes and plug-ins because it looks redundant in the
+ documentation.
+ * tools/extra_defs_gen/generate_plugin_gmmproc_file.cc: Correct help
+ information that is printed at the command line with the '-?' option.
+
2010-01-28 José Alburquerque <jaalburqu svn gnome org>
Include new core and base plug-ins (queue2 and subtitleoverlay).
diff --git a/gstreamer/src/audioclock.hg b/gstreamer/src/audioclock.hg
index af37abd..5e1bd79 100644
--- a/gstreamer/src/audioclock.hg
+++ b/gstreamer/src/audioclock.hg
@@ -25,7 +25,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::AudioClock - Helper object for implementing audio clocks.
+/** A Helper object for implementing audio clocks.
* Gst::AudioClock makes it easy for elements to implement a Gst::Clock,
* they simply need to provide a slot that returns the current clock time.
*
diff --git a/gstreamer/src/audiofilter.hg b/gstreamer/src/audiofilter.hg
index d77216a..6133f37 100644
--- a/gstreamer/src/audiofilter.hg
+++ b/gstreamer/src/audiofilter.hg
@@ -25,7 +25,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::AudioFilter - Base class for simple audio filters.
+/** A base class for simple audio filters.
* Gst::AudioFilter is a Gst::BaseTransform-derived base class for simple
* audio filters, ie. those that output the same format that they get as input.
*
diff --git a/gstreamer/src/audiosink.hg b/gstreamer/src/audiosink.hg
index e313299..09518dd 100644
--- a/gstreamer/src/audiosink.hg
+++ b/gstreamer/src/audiosink.hg
@@ -26,7 +26,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::AudioSink - Simple base class for audio sinks.
+/** A simple base class for audio sinks.
* This is the most simple base class for audio sinks that only requires
* subclasses to implement a set of simple virtual functions:
*
diff --git a/gstreamer/src/audiosrc.hg b/gstreamer/src/audiosrc.hg
index 0ec1b16..befa47d 100644
--- a/gstreamer/src/audiosrc.hg
+++ b/gstreamer/src/audiosrc.hg
@@ -26,7 +26,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::AudioSrc - Simple base class for audio sources.
+/** A simple base class for audio sources.
* This is the most simple base class for audio sources that only requires
* subclasses to implement a set of simple virtual functions:
*
diff --git a/gstreamer/src/baseaudiosink.hg b/gstreamer/src/baseaudiosink.hg
index c91e0c4..44f1af4 100644
--- a/gstreamer/src/baseaudiosink.hg
+++ b/gstreamer/src/baseaudiosink.hg
@@ -29,7 +29,7 @@ class RingBuffer;
_WRAP_ENUM(BaseAudioSinkSlaveMethod, GstBaseAudioSinkSlaveMethod)
-/** Gst::BaseAudioSink - Base class for audio sinks.
+/** The base class for audio sinks.
* This is the base class for audio sinks. Subclasses need to implement the
* create_ringbuffer_vfunc vmethod. This base class will then take care of
* writing samples to the ringbuffer, synchronisation, clipping and flushing.
diff --git a/gstreamer/src/baseaudiosrc.hg b/gstreamer/src/baseaudiosrc.hg
index 61d01d0..beddade 100644
--- a/gstreamer/src/baseaudiosrc.hg
+++ b/gstreamer/src/baseaudiosrc.hg
@@ -29,7 +29,7 @@ class RingBuffer;
_WRAP_ENUM(BaseAudioSrcSlaveMethod, GstBaseAudioSrcSlaveMethod)
-/** Gst::BaseAudioSrc - Base class for audio sources.
+/** The base class for audio sources.
* This is the base class for audio sources. Subclasses need to implement the
* create_ringbuffer_vfunc vmethod. This base class will then take care of
* reading samples from the ringbuffer, synchronisation and flushing.
diff --git a/gstreamer/src/basesink.hg b/gstreamer/src/basesink.hg
index d3d7995..7236d96 100644
--- a/gstreamer/src/basesink.hg
+++ b/gstreamer/src/basesink.hg
@@ -27,7 +27,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::BaseSink - Base class for sink elements.
+/** The base class for sink elements.
* Gst::BaseSink is the base class for sink elements in GStreamer, such as
* xvimagesink or filesink. It is a layer on top of Gst::Element that provides
* a simplified interface to plugin writers. Gst::BaseSink handles many details
diff --git a/gstreamer/src/basesrc.hg b/gstreamer/src/basesrc.hg
index 36de5ba..851c9bb 100644
--- a/gstreamer/src/basesrc.hg
+++ b/gstreamer/src/basesrc.hg
@@ -29,7 +29,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::BaseSrc - Base class for getrange based source elements.
+/** A base class for getrange based source elements.
* This is a generice base class for source elements. The following types of
* sources are supported:
*
diff --git a/gstreamer/src/basetransform.hg b/gstreamer/src/basetransform.hg
index 5c2cc41..fa93b33 100644
--- a/gstreamer/src/basetransform.hg
+++ b/gstreamer/src/basetransform.hg
@@ -33,7 +33,7 @@ const Glib::ustring BASE_TRANSFORM_SINK_NAME = GST_BASE_TRANSFORM_SINK_NAME;
*/
const Glib::ustring BASE_TRANSFORM_SRC_NAME = GST_BASE_TRANSFORM_SRC_NAME;
-/** Gst::BaseTransform - Base class for simple transform filters.
+/** A base class for simple transform filters.
* This base class is for filter elements that process data.
*
* It provides for:
@@ -62,7 +62,7 @@ const Glib::ustring BASE_TRANSFORM_SRC_NAME = GST_BASE_TRANSFORM_SRC_NAME;
* .
* <B>Example elements</B>
* - Level
- * - Videoscale, audioconvert, ffmpegcolorspace, audioresample in
+ * - VideoScale, AudioConvert, FfmpegColorSpace, AudioResample in
* certain modes.
* .
* - <B>2. Modifications in-place - input buffer and output buffer are the
@@ -80,8 +80,8 @@ const Glib::ustring BASE_TRANSFORM_SRC_NAME = GST_BASE_TRANSFORM_SRC_NAME;
* .
* <B>Example elements</B>
* - Volume.
- * - Audioconvert in certain modes (signed/unsigned conversion).
- * - ffmpegcolorspace in certain modes (endianness swapping).
+ * - AudioConvert in certain modes (signed/unsigned conversion).
+ * - FfmpegColorSpace in certain modes (endianness swapping).
*
* - <B>3. Modifications only to the caps/metadata of a buffer</B>
* - The element does not require writable data, but non-writable
@@ -92,8 +92,8 @@ const Glib::ustring BASE_TRANSFORM_SRC_NAME = GST_BASE_TRANSFORM_SRC_NAME;
* input buffer and set always_in_place to TRUE.
* .
* <B>Example elements</B>
- * - Capsfilter when setting caps on outgoing buffers that have none.
- * - identity when it is going to re-timestamp buffers by datarate.
+ * - CapsFilter when setting caps on outgoing buffers that have none.
+ * - Identity when it is going to re-timestamp buffers by datarate.
*
* - <B>4. Normal mode</B>
* - always_in_place flag is not set, or there is no
@@ -104,7 +104,7 @@ const Glib::ustring BASE_TRANSFORM_SRC_NAME = GST_BASE_TRANSFORM_SRC_NAME;
* prepare_output_buffer_vfunc() function.
* .
* <B>Example elements</B>
- * - Videoscale, ffmpegcolorspace, audioconvert when doing
+ * - VideoScale, FfmpegColorSpace, AudioConvert when doing
* scaling/conversions.
*
* - <B>5. Special output buffer allocations</B>
@@ -114,7 +114,7 @@ const Glib::ustring BASE_TRANSFORM_SRC_NAME = GST_BASE_TRANSFORM_SRC_NAME;
* parent implementation and passes the newly allocated buffer.
* .
* <B>Example elements</B>
- * - efence.
+ * - Efence.
*
* <B>Sub-class settable flags on Gst::BaseTransform</B>
*
diff --git a/gstreamer/src/bin.hg b/gstreamer/src/bin.hg
index 9297438..7d61a72 100644
--- a/gstreamer/src/bin.hg
+++ b/gstreamer/src/bin.hg
@@ -33,7 +33,7 @@ class GhostPad;
template <class CppType>
class Iterator;
-/** Gst::Bin - Base class and element that can contain other elements.
+/** A base class and element that can contain other elements.
* Gst::Bin is an element that can contain other Gst::Element, allowing them to
* be managed as a group. Pads from the child elements can be ghosted to the
* bin, see Gst::GhostPad. This makes the bin look like any other elements and
diff --git a/gstreamer/src/buffer.hg b/gstreamer/src/buffer.hg
index 5d8f581..713ce02 100644
--- a/gstreamer/src/buffer.hg
+++ b/gstreamer/src/buffer.hg
@@ -30,7 +30,7 @@ namespace Gst
_WRAP_ENUM(BufferFlag, GstBufferFlag)
_WRAP_ENUM(BufferCopyFlags, GstBufferCopyFlags)
-/** Gst::Buffer - Data-passing buffer type, supporting sub-buffers.
+/** A data-passing buffer type, supporting sub-buffers.
* Buffers are the basic unit of data transfer in GStreamer. The Gst::Buffer
* type provides all the state necessary to define a region of memory as part
* of a stream. Sub-buffers are also supported, allowing a smaller region of a
diff --git a/gstreamer/src/bus.hg b/gstreamer/src/bus.hg
index cdebca0..463cdd8 100644
--- a/gstreamer/src/bus.hg
+++ b/gstreamer/src/bus.hg
@@ -40,7 +40,7 @@ _WRAP_ENUM(BusFlags, GstBusFlags)
*/
_WRAP_ENUM(BusSyncReply, GstBusSyncReply)
-/** Gst::Bus - Asynchronous message bus subsystem.
+/** A class that encompasses the GStreamer asynchronous message bus subsystem.
* The Gst::Bus is an object responsible for delivering Messages in a first-in
* first-out way from the streaming threads to the application.
*
diff --git a/gstreamer/src/caps.hg b/gstreamer/src/caps.hg
index 984c51b..00a571e 100644
--- a/gstreamer/src/caps.hg
+++ b/gstreamer/src/caps.hg
@@ -28,20 +28,21 @@ namespace Gst
struct Structure;
-/** Gst::Caps (capabilities) are lightweight objects describing media
- * formats. They are composed of an array of Gst::Structure.
+/** A class that describes sets of media formats.
+ * Caps (capabilities) are lightweight objects describing media formats. They
+ * are composed of an array of Gst::Structure.
*
- * Gst::Caps are exposed on Gst::PadTemplate to describe all possible types a
- * given pad can handle. They are also stored in the Gst::Registry along with a
+ * Caps are exposed on Gst::PadTemplate to describe all possible types a given
+ * pad can handle. They are also stored in the Gst::Registry along with a
* description of the Gst::Element.
*
- * Gst::Caps are exposed on the element pads using the Gst::Pad::get_caps()
- * method. This method describes the possible types that the pad can handle or
- * produce at runtime.
+ * Caps are exposed on the element pads using the Gst::Pad::get_caps() method.
+ * This method describes the possible types that the pad can handle or produce
+ * at runtime.
*
- * Gst::Caps are also attached to buffers to describe to content of the data
- * pointed to by the buffer with Gst::Buffer::set_caps(). Gst::Caps attached to
- * a Gst::Buffer allow for format negotiation upstream and downstream.
+ * Caps are also attached to buffers to describe to content of the data
+ * pointed to by the buffer with Gst::Buffer::set_caps(). Gst::Caps attached
+ * to a Gst::Buffer allow for format negotiation upstream and downstream.
*
* A Gst::Caps can be constructed with the following code fragment:
*
diff --git a/gstreamer/src/cddabasesrc.hg b/gstreamer/src/cddabasesrc.hg
index 67a5d85..523338b 100644
--- a/gstreamer/src/cddabasesrc.hg
+++ b/gstreamer/src/cddabasesrc.hg
@@ -28,7 +28,7 @@ namespace Gst
_WRAP_ENUM(CddaBaseSrcMode,GstCddaBaseSrcMode)
-/** Gst::CddaBaseSrc - Base class for CD digital audio (CDDA) sources.
+/** A base class for CD digital audio (CDDA) sources.
* Provides a base class for CDDA sources, which handles things like seeking,
* querying, discid calculation, tags, and buffer timestamping.
*
diff --git a/gstreamer/src/childproxy.hg b/gstreamer/src/childproxy.hg
index adc62b1..bbba761 100644
--- a/gstreamer/src/childproxy.hg
+++ b/gstreamer/src/childproxy.hg
@@ -26,7 +26,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::ChildProxy - An interface for multi child elements.
+/** An interface for multi child elements.
* This interface abstracts handling of property sets for child elements.
* Imagine elements such as mixers or polyphonic generators. They all have
* multiple Gst::Pad or some kind of voice objects. The element acts as a
diff --git a/gstreamer/src/clock.hg b/gstreamer/src/clock.hg
index 50c9fd4..ffb53a0 100644
--- a/gstreamer/src/clock.hg
+++ b/gstreamer/src/clock.hg
@@ -27,31 +27,31 @@ namespace Gst
class Clock;
-/** A datatype to hold a time, measured in nanoseconds.
+/** A data type to hold a time, measured in nanoseconds.
*/
typedef GstClockTime ClockTime;
-/** A datatype to hold a timedifference, measured in nanoseconds.
+/** A data type to hold a timedifference, measured in nanoseconds.
*/
typedef GstClockTimeDiff ClockTimeDiff;
-/** Constant to define an undefined clock time.
+/** A constant to define an undefined clock time.
*/
const ClockTime CLOCK_TIME_NONE = GST_CLOCK_TIME_NONE;
-/** Constant that defines one GStreamer second.
+/** A constant that defines one GStreamer second.
*/
const ClockTime SECOND = GST_SECOND;
-/** Constant that defines one GStreamer millisecond.
+/** A constant that defines one GStreamer millisecond.
*/
const ClockTime MILLI_SECOND = GST_MSECOND;
-/** Constant that defines one GStreamer microsecond.
+/** A constant that defines one GStreamer microsecond.
*/
const ClockTime MICRO_SECOND = GST_USECOND;
-/** Constant that defines one GStreamer nanosecond.
+/** A constant that defines one GStreamer nanosecond.
*/
const ClockTime NANO_SECOND = GST_NSECOND;
@@ -59,7 +59,7 @@ _WRAP_ENUM(ClockEntryType, GstClockEntryType)
_WRAP_ENUM(ClockReturn, GstClockReturn)
_WRAP_ENUM(ClockFlags, GstClockFlags)
-/** A datatype to hold the handle to an outstanding sync or async clock
+/** A data type to hold the handle to an outstanding sync or async clock
* callback.
*/
class ClockID
@@ -103,49 +103,50 @@ public:
_WRAP_METHOD(void unschedule(), gst_clock_id_unschedule)
};
-/** Get hour component of Gst::ClockTime.
+/** Gets the hour component of Gst::ClockTime.
* @param time The Gst::ClockTime to parse.
* @return The hour component of the Gst::ClockTime.
*/
guint get_hours(ClockTime time);
-/** Get minute component of Gst::ClockTime.
+/** Gets the minute component of Gst::ClockTime.
* @param time The Gst::ClockTime to parse.
* @return The minute component of the Gst::ClockTime.
*/
guint get_minutes(ClockTime time);
-/** Get seconds component of Gst::ClockTime.
+/** Gets the seconds component of Gst::ClockTime.
* @param time The Gst::ClockTime to parse.
* @return The seconds component of the Gst::ClockTime.
*/
guint get_seconds(ClockTime time);
-/** Get milliseconds component of Gst::ClockTime.
+/** Gets the milliseconds component of Gst::ClockTime.
* @param time The Gst::ClockTime to parse.
* @return The milliseconds component of the Gst::ClockTime.
*/
guint get_milliseconds(ClockTime time);
-/** Get microseconds component of Gst::ClockTime.
+/** Gets the microseconds component of Gst::ClockTime.
* @param time The Gst::ClockTime to parse.
* @return The microseconds component of the Gst::ClockTime.
*/
guint get_microseconds(ClockTime time);
-/** Get nanoseconds component of Gst::ClockTime.
+/** Gets the nanoseconds component of Gst::ClockTime.
* @param time The Gst::ClockTime to parse.
* @return The nanoseconds component of the Gst::ClockTime.
*/
guint get_nanoseconds(ClockTime time);
-/** Get fractional component (milli, micro and nano seconds) of Gst::ClockTime.
+/** Gets the fractional component (milli, micro and nano seconds) of
+ * Gst::ClockTime.
* @param time The Gst::ClockTime to parse.
* @return The fractional component of the Gst::ClockTime.
*/
guint get_fractional_seconds(ClockTime time);
-/** Gst::Clock - Abstract class for global clocks.
+/** An abstract class for global clocks.
* GStreamer uses a global clock to synchronize the plugins in a pipeline.
* Different clock implementations are possible by implementing this abstract
* base class.
diff --git a/gstreamer/src/colorbalance.hg b/gstreamer/src/colorbalance.hg
index fd04bc2..1e23a1d 100644
--- a/gstreamer/src/colorbalance.hg
+++ b/gstreamer/src/colorbalance.hg
@@ -29,7 +29,7 @@ _WRAP_ENUM(ColorBalanceType, GstColorBalanceType)
class ColorBalanceChannel;
-/** Gst::ColorBalance - Interface for adjusting color balance settings.
+/** An interface for adjusting color balance settings.
* @ingroup GstInterfaces
*/
class ColorBalance : public Glib::Interface
diff --git a/gstreamer/src/colorbalancechannel.hg b/gstreamer/src/colorbalancechannel.hg
index 50c37fa..f8beeee 100644
--- a/gstreamer/src/colorbalancechannel.hg
+++ b/gstreamer/src/colorbalancechannel.hg
@@ -25,7 +25,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::ColorBalanceChannel - Represents a color balance channel.
+/** A class that represents a color balance channel.
* @ingroup GstInterfaces
*/
class ColorBalanceChannel : public Glib::Object
diff --git a/gstreamer/src/element.hg b/gstreamer/src/element.hg
index c700eb6..61a9575 100644
--- a/gstreamer/src/element.hg
+++ b/gstreamer/src/element.hg
@@ -95,7 +95,7 @@ Glib::ustring get_name(StateChangeReturn state_ret);
} //namespace Enums
-/** Gst::Element - Abstract base class for all pipeline elements.
+/** The abstract base class for all pipeline elements.
* Gst::Element is the abstract base class needed to construct an element that
* can be used in a GStreamer pipeline. Please refer to the plugin writers
* guide for more information on creating Gst::Element subclasses.
@@ -430,7 +430,7 @@ protected:
#m4end
};
-/** Templated class used for casting Gst::Element to interfaces that its
+/** A templated class used for casting Gst::Element to interfaces that its
* underlying gobject implements.
* Gst::ElementInterfaced is a templated class which, in conjunction with
* Gst::Interface::cast(), is used to cast a Gst::Element obtained by
diff --git a/gstreamer/src/elementfactory.hg b/gstreamer/src/elementfactory.hg
index 2e1e09a..34df234 100644
--- a/gstreamer/src/elementfactory.hg
+++ b/gstreamer/src/elementfactory.hg
@@ -30,7 +30,7 @@ class Element;
class PadTemplate;
class Plugin;
-/** Gst::ElementFactory - Create Gst::Element from a factory.
+/** A class that creates Gst::Element objects from a factory.
* Gst::ElementFactory is used to create instances of elements. A
* Gst::ElementFactory can be added to a Gst::Plugin as it is also a
* Gst::PluginFeature. Use find() to get a particular element factory. Use
diff --git a/gstreamer/src/error.hg b/gstreamer/src/error.hg
index 8a8bedf..5aedbf6 100644
--- a/gstreamer/src/error.hg
+++ b/gstreamer/src/error.hg
@@ -78,8 +78,8 @@ namespace Gst
*/
_WRAP_GERROR(CoreError, GstCoreError, GST_CORE_ERROR, NO_GTYPE)
-/** Get error domain for core system. Errors in this domain will be from the
- * Gst::CoreError enumeration.
+/** Gets the error domain for core system. Errors in this domain will be from
+ * the Gst::CoreError enumeration.
*
* @return The quark associated with the core error domain.
*/
@@ -132,8 +132,8 @@ Glib::QueryQuark get_core_error_quark();
*/
_WRAP_GERROR(LibraryError, GstLibraryError, GST_LIBRARY_ERROR, NO_GTYPE)
-/** Get error domain for library loading. Errors in this domain will be from
- * the Gst::LibraryError enumeration.
+/** Gets the error domain for library loading. Errors in this domain will be
+ * from the gst::libraryerror enumeration.
*
* @return The quark associated with the library error domain.
*/
@@ -196,8 +196,8 @@ Glib::QueryQuark get_library_error_quark();
*/
_WRAP_GERROR(ResourceError, GstResourceError, GST_RESOURCE_ERROR, NO_GTYPE)
-/** Get error domain for resource handling. Errors in this domain will be from
- * the Gst::ResourceError enumeration.
+/** Gets error domain for resource handling. Errors in this domain will be
+ * from the Gst::ResourceError enumeration.
*
* @return The quark associated with the resource error domain.
*/
@@ -262,8 +262,8 @@ Glib::QueryQuark get_resource_error_quark();
*/
_WRAP_GERROR(StreamError, GstStreamError, GST_STREAM_ERROR, NO_GTYPE)
-/** Get error domain for media stream processing. Errors in this domain will be
- * from the Gst::StreamError enumeration.
+/** Gets error domain for media stream processing. Errors in this domain will
+ * be from the Gst::StreamError enumeration.
*
* @return The quark associated with the media stream error domain.
*/
diff --git a/gstreamer/src/event.hg b/gstreamer/src/event.hg
index 4ab6627..6be9729 100644
--- a/gstreamer/src/event.hg
+++ b/gstreamer/src/event.hg
@@ -63,14 +63,14 @@ class TagList;
namespace Enums
{
-/** Get a printable name for the given event type.
+/** Gets a printable name for the given event type.
*
* @param type The event type.
* @return A reference to the static name of the event.
*/
Glib::ustring get_name(EventType type);
-/** Get the unique quark for the given event type.
+/** Gets the unique quark for the given event type.
*
* @param type The event type.
* @return The quark associated with the event type.
@@ -85,8 +85,7 @@ EventTypeFlags get_flags(EventType type);
} //namespace Enums
-/** Gst::Event - A structure describing events that are passed up and down a
- * pipeline.
+/** A class that represents events that are passed up and down a pipeline.
* The event class provides factory methods to construct and functions query
* (parse) events.
*
diff --git a/gstreamer/src/filter.hg b/gstreamer/src/filter.hg
index a195050..d6a384b 100644
--- a/gstreamer/src/filter.hg
+++ b/gstreamer/src/filter.hg
@@ -22,7 +22,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::Filter - A utility function to filter Lists.
+/** A class used to filter lists.
*/
class Filter
{
diff --git a/gstreamer/src/format.hg b/gstreamer/src/format.hg
index f5e298d..cec0004 100644
--- a/gstreamer/src/format.hg
+++ b/gstreamer/src/format.hg
@@ -30,8 +30,8 @@ class IteratorBasic;
_WRAP_ENUM(Format, GstFormat)
-/** A format definition is used to get details of a Gst::Format by
- * Gst::get_details().
+/** A class to store the details of a Gst::Format retrieved by
+ * Gst::get_format_details().
*/
class FormatDefinition
{
@@ -63,14 +63,14 @@ public:
namespace Enums
{
-/** Get a printable name for the given format. Do not modify or free.
+/** Gets a printable name for the given format. Do not modify or free.
*
* @param format A Gst::Format.
* @return The name of the format or an empty string if the format is unknown.
*/
Glib::ustring get_name(Format format);
-/** Get the unique quark for the given format.
+/** Gets the unique quark for the given format.
*
* @param format A Gst::Format.
* @return The quark associated with the format or 0 if the format is unknown.
@@ -79,8 +79,8 @@ Glib::QueryQuark get_quark(Format format);
} //namespace Enums
-/** Create a new Gst::Format based on the nick or return an already registered
- * format with that nick.
+/** Creates a new Gst::Format based on the nick or return an already
+ * registered format with that nick.
*
* @param nick The nick of the new format.
* @param description The description of the new format.
@@ -90,7 +90,7 @@ Glib::QueryQuark get_quark(Format format);
Format register_format(const Glib::ustring& nick, const Glib::ustring&
description);
-/** Return the format registered with the given nick.
+/** Returns the format registered with the given nick.
*
* @param nick The nick of the format.
* @return The format with nick or Gst::FORMAT_UNDEFINED if the format was not
@@ -98,7 +98,7 @@ description);
*/
Format get_format(const Glib::ustring& nick);
-/** See if the given format is inside the array of formats.
+/** Sees if the given format is inside the array of formats.
*
* @param formats The array of formats to search.
* @param format The format to find.
@@ -106,7 +106,7 @@ Format get_format(const Glib::ustring& nick);
*/
bool formats_contain(const Glib::ArrayHandle<Format>& formats, Format format);
-/** Get details about the given format.
+/** Gets details about the given format.
*
* @param format The format to get details of.
* @param def The Gst::FormatDefinition in which to store the details of
@@ -115,7 +115,8 @@ bool formats_contain(const Glib::ArrayHandle<Format>& formats, Format format);
*/
bool get_format_details(Format format, FormatDefinition& def);
-/** Iterate all the registered formats. The format definitions are read only.
+/** Iterates all the registered formats. The format definitions are read
+ * only.
* @return a Gst::IteratorBasic of Gst::FormatDefinition.
*/
IteratorBasic<const FormatDefinition> iterate_format_definitions();
diff --git a/gstreamer/src/ghostpad.hg b/gstreamer/src/ghostpad.hg
index be439c2..644664e 100644
--- a/gstreamer/src/ghostpad.hg
+++ b/gstreamer/src/ghostpad.hg
@@ -24,7 +24,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::GhostPad - Pseudo link pads.
+/** A class that represents pseudo link pads.
* Gst::GhostPad are useful when organizing pipelines with Gst::Bin like
* elements.
* The idea here is to create hierarchical element graphs. The bin element
diff --git a/gstreamer/src/index.hg b/gstreamer/src/index.hg
index bac1dae..759c108 100644
--- a/gstreamer/src/index.hg
+++ b/gstreamer/src/index.hg
@@ -66,7 +66,8 @@ public:
};
-/** Gst::Index is used to generate a stream index of one or more elements in a pipeline.
+/** A class that generates a stream index of one or more elements in a
+ * pipeline.
*/
class Index : public Object
{
diff --git a/gstreamer/src/indexfactory.hg b/gstreamer/src/indexfactory.hg
index e1ddeb1..c5ac7b1 100644
--- a/gstreamer/src/indexfactory.hg
+++ b/gstreamer/src/indexfactory.hg
@@ -27,7 +27,7 @@ namespace Gst
class Index;
-/** Gst::IndexFactory - Create Indexes from a factory.
+/** A class that creates Gst::Index objects from a factory.
* Gst::IndexFactory is used to dynamically create Gst::Index implementations.
*/
class IndexFactory : public PluginFeature
diff --git a/gstreamer/src/interface.hg b/gstreamer/src/interface.hg
index c940d95..f3a4d24 100644
--- a/gstreamer/src/interface.hg
+++ b/gstreamer/src/interface.hg
@@ -25,8 +25,8 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Core interface implemented by Gst::Element instances that
- * allows runtime querying of interface availability.
+/** The core interface implemented by Gst::Element instances that allows
+ * runtime querying of interface availability.
* This provides interface functionality on a per-instance basis and not a
* per-class basis, which is the case for GObject.
* @ingroup GstInterfaces
diff --git a/gstreamer/src/iterator.hg b/gstreamer/src/iterator.hg
index 40b40bc..60c57e6 100644
--- a/gstreamer/src/iterator.hg
+++ b/gstreamer/src/iterator.hg
@@ -28,8 +28,8 @@ namespace Gst
_WRAP_ENUM(IteratorItem, GstIteratorItem)
_WRAP_ENUM(IteratorResult, GstIteratorResult)
-/** Gst::IteratorBase - Base class for classes that retrieve multiple elements
- * in a thread safe way.
+/** The base class for classes that retrieve multiple elements in a thread
+ * safe way.
*
* Classes derived from Gst::IteratorBase are used to retrieve multiple objects
* from another object in a thread safe way. They are implemented as C++ like
@@ -130,8 +130,7 @@ private:
void swap(IteratorBase<CppType>& other);
};
-/** Gst::IteratorBasic - Class that retrieves multiple elements in a thread
- * safe way.
+/** A class used to retrieve multiple elements in a thread safe way.
* Gst::IteratorBasic iterates specifically through elements that are not
* reference counted. Gst::Iterator is used for iterating through reference
* counted objects.
@@ -184,8 +183,8 @@ public:
IteratorBasic<CppType> operator++(int);
};
-/** Gst::Iterator - Class that retrieve multiple reference counted elements in
- * a thread safe way.
+/** A class used to retrieve multiple reference counted elements in a thread
+ * safe way.
* Gst::Iterator iterates specifically through elements that are reference
* counted and therefore dereferencing the elements of the iterator yields a
* Glib::RefPtr<> to the C++ element type.
diff --git a/gstreamer/src/message.hg b/gstreamer/src/message.hg
index 1299c04..52b81da 100644
--- a/gstreamer/src/message.hg
+++ b/gstreamer/src/message.hg
@@ -37,13 +37,13 @@ _WRAP_ENUM(StreamStatusType, GstStreamStatusType)
namespace Enums
{
-/** Get a printable name for the given message type.
+/** Gets a printable name for the given message type.
* @param type The message type.
* @return The name of the message type.
*/
Glib::ustring get_name(MessageType type);
-/** Get the unique quark for the given message type.
+/** Gets the unique quark for the given message type.
* @param type The message type.
* @return The quark associated with the message type.
*/
@@ -56,8 +56,8 @@ class Pad;
class Structure;
class TagList;
-/** Gst::Message - Lightweight objects to signal the application of pipeline
- * events.
+/** A class that represents lightweight objects to signal the application of
+ * pipeline events.
* Messages are implemented as a subclass of Gst::MiniObject with a generic
* Gst::Structure as the content. This allows for writing custom messages
* without requiring an API change while allowing a wide range of different
diff --git a/gstreamer/src/mixer.hg b/gstreamer/src/mixer.hg
index 5c41c58..deb6190 100644
--- a/gstreamer/src/mixer.hg
+++ b/gstreamer/src/mixer.hg
@@ -35,7 +35,7 @@ _WRAP_ENUM(MixerMessageType, GstMixerMessageType)
class MixerOptions;
class MixerTrack;
-/** Gst::Mixer - Interface for elements that provide mixer operations.
+/** An interface for elements that provide mixer operations.
* @ingroup GstInterfaces
*/
class Mixer : public Glib::Interface
diff --git a/gstreamer/src/mixeroptions.hg b/gstreamer/src/mixeroptions.hg
index 7037b43..da1c138 100644
--- a/gstreamer/src/mixeroptions.hg
+++ b/gstreamer/src/mixeroptions.hg
@@ -24,7 +24,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::MixerOptions - Options for elements that implement the * Gst::Mixer
+/** A class that represents options for elements that implement the Gst::Mixer
* interface.
* @ingroup GstInterfaces
*/
diff --git a/gstreamer/src/mixertrack.hg b/gstreamer/src/mixertrack.hg
index 5f65f7d..c1bb175 100644
--- a/gstreamer/src/mixertrack.hg
+++ b/gstreamer/src/mixertrack.hg
@@ -26,8 +26,7 @@ namespace Gst
_WRAP_ENUM(MixerTrackFlags, GstMixerTrackFlags)
-/** Gst::MixerTrack - A track in an element that implement the Gst::Mixer
- * interface.
+/** A track in an element that implement the Gst::Mixer interface.
* @ingroup GstInterfaces
*/
class MixerTrack : public Glib::Object
diff --git a/gstreamer/src/navigation.hg b/gstreamer/src/navigation.hg
index f340031..9f4514e 100644
--- a/gstreamer/src/navigation.hg
+++ b/gstreamer/src/navigation.hg
@@ -29,8 +29,7 @@ _WRAP_ENUM(NavigationCommand, GstNavigationCommand)
class Structure;
-/** Gst::Naviagtion - Interface for elements that provide navigation
- * functionality.
+/** An interface for elements that provide navigation functionality.
* @ingroup GstInterfaces
*/
class Navigation : public Glib::Interface
diff --git a/gstreamer/src/object.hg b/gstreamer/src/object.hg
index bd46816..37361f7 100644
--- a/gstreamer/src/object.hg
+++ b/gstreamer/src/object.hg
@@ -33,7 +33,7 @@ _WRAP_ENUM(ObjectFlags, GstObjectFlags)
* these).
*/
-/** Gst::Object - Base class for the GStreamer object hierarchy.
+/** A base class for the GStreamer object hierarchy.
* Gst::Object provides a root for the object hierarchy tree filed in by the
* GStreamer library. It is currently a thin wrapper on top of Glib::Object.
* It is an abstract class that is not very usable on its own.
diff --git a/gstreamer/src/pad.hg b/gstreamer/src/pad.hg
index 6ce19a8..fc4a69a 100644
--- a/gstreamer/src/pad.hg
+++ b/gstreamer/src/pad.hg
@@ -45,8 +45,8 @@ _WRAP_ENUM(PadLinkReturn, GstPadLinkReturn)
_WRAP_ENUM(FlowReturn, GstFlowReturn)
_WRAP_ENUM(ActivateMode, GstActivateMode)
-/** Gst::Pad - Object contained by elements that allows links to other
- * elements.
+/** A class that represents objects contained by elements that allows links to
+ * other elements.
* A Gst::Element is linked to other elements via "pads", which are extremely
* light-weight generic link points. After two pads are retrieved from an
* element with Element::get_pad(), the pads can be link with link(). (For
diff --git a/gstreamer/src/padtemplate.hg b/gstreamer/src/padtemplate.hg
index a8403dc..c9139bb 100644
--- a/gstreamer/src/padtemplate.hg
+++ b/gstreamer/src/padtemplate.hg
@@ -33,7 +33,7 @@ _WRAP_ENUM(PadPresence, GstPadPresence)
class Caps;
class Pad;
-/** Gst::PadTemplate - Describe the media type of a pad.
+/** A class that describes the media type of a pad.
* Padtemplates describe the possible media types a pad or an elementfactory
* can handle. This allows for both inspection of handled types before loading
* the element plugin as well as identifying pads on elements that are not yet
diff --git a/gstreamer/src/parse.hg b/gstreamer/src/parse.hg
index 2781743..69dc142 100644
--- a/gstreamer/src/parse.hg
+++ b/gstreamer/src/parse.hg
@@ -38,7 +38,7 @@ class Element;
*/
_WRAP_GERROR(ParseError, GstParseError, GST_PARSE_ERROR)
-/** Gst::Parse - Get a pipeline from a text pipeline description.
+/** A class that gets a pipeline from a text pipeline description.
* The methods in this class allow to create a pipeline based on the syntax
* used in the gst-launch utillity.
*/
diff --git a/gstreamer/src/pipeline.hg b/gstreamer/src/pipeline.hg
index 39ba739..10f8b8a 100644
--- a/gstreamer/src/pipeline.hg
+++ b/gstreamer/src/pipeline.hg
@@ -27,12 +27,12 @@ namespace Gst
class Bus;
-/** A Gst::Pipeline is a special Gst::Bin used as the toplevel container for
- * the filter graph.
- * The Gst::Pipeline will manage the selection and distribution of a global
- * Gst::Clock as well as provide a Gst::Bus to the application. It will also
- * implement a default behavour for managing seek events (see
- * Gst::Element::seek()).
+/** A top-level bin with clocking and bus management functionality.
+ * A Gst::Pipeline is a special Gst::Bin used as the toplevel container for
+ * the filter graph. The Gst::Pipeline will manage the selection and
+ * distribution of a global Gst::Clock as well as provide a Gst::Bus to the
+ * application. It will also implement a default behavour for managing seek
+ * events (see Gst::Element::seek()).
*
* create() is used to create a pipeline. when the pipeline is destroyed all
* its resources including all added Gst::Element objects are destroyed.
diff --git a/gstreamer/src/plugin.hg b/gstreamer/src/plugin.hg
index 84fbda6..15a4adc 100644
--- a/gstreamer/src/plugin.hg
+++ b/gstreamer/src/plugin.hg
@@ -27,7 +27,7 @@ namespace Gst
_WRAP_ENUM(PluginDependencyFlags, GstPluginDependencyFlags)
-/** The plugin loading errors
+/** The plugin loading errors.
*
* - MODULE - The plugin could not be loaded
* - DEPENDENCIES - The plugin has unresolved dependencies
@@ -37,7 +37,7 @@ _WRAP_GERROR(PluginError, GstPluginError, GST_PLUGIN_ERROR)
class Structure;
-/** Gst::Plugin - Container for features loaded from a shared object module.
+/** A container for features loaded from a shared object module.
* GStreamer is extensible, so Gst::Element instances can be loaded at runtime.
* A plugin system can provide one or more of the basic GStreamer
* Gst::PluginFeature subclasses.
diff --git a/gstreamer/src/pluginfeature.hg b/gstreamer/src/pluginfeature.hg
index 2caf884..d9b0742 100644
--- a/gstreamer/src/pluginfeature.hg
+++ b/gstreamer/src/pluginfeature.hg
@@ -27,7 +27,7 @@ namespace Gst
_WRAP_ENUM(Rank, GstRank)
-/** This is a base class for anything that can be added to a Gst::Plugin.
+/** A base class for anything that can be added to a Gst::Plugin.
*
*/
class PluginFeature : public Object
diff --git a/gstreamer/src/preset.hg b/gstreamer/src/preset.hg
index c0f7a94..f24c39f 100644
--- a/gstreamer/src/preset.hg
+++ b/gstreamer/src/preset.hg
@@ -25,7 +25,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::Preset - helper interface for element presets.
+/** A helper interface for element presets.
* This interface offers methods to query and manipulate parameter preset sets.
* A preset is a bunch of property settings, together with meta data and a
* name. The name of a preset serves as key for subsequent method calls to
diff --git a/gstreamer/src/propertyprobe.hg b/gstreamer/src/propertyprobe.hg
index 846e545..24b0dac 100644
--- a/gstreamer/src/propertyprobe.hg
+++ b/gstreamer/src/propertyprobe.hg
@@ -25,7 +25,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::PropertyProbe - Interface for probing possible property values.
+/** An interface for probing possible property values.
* The property probe is a way to autodetect allowed values for a GObject
* property. Its primary use is to autodetect device-names in several
* elements.
diff --git a/gstreamer/src/pushsrc.hg b/gstreamer/src/pushsrc.hg
index 2318aa6..ab13e53 100644
--- a/gstreamer/src/pushsrc.hg
+++ b/gstreamer/src/pushsrc.hg
@@ -24,7 +24,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::PushSrc - Base class for push based source elements.
+/** A base class for push based source elements.
* This class is mostly useful for elements that cannot do random access, or at
* least very slowly. The source usually prefers to push out a fixed size
* buffer.
diff --git a/gstreamer/src/query.hg b/gstreamer/src/query.hg
index c4f2cc2..d2efd9c 100644
--- a/gstreamer/src/query.hg
+++ b/gstreamer/src/query.hg
@@ -35,7 +35,7 @@ class IteratorBasic;
_WRAP_ENUM(QueryType, GstQueryType)
_WRAP_ENUM(BufferingMode, GstBufferingMode)
-/** A query type definition is used to get details of a Gst::Query by
+/** A class to store the details of a Gst::Query retrieved by
* Gst::Query::get_details().
*/
class QueryTypeDefinition
@@ -68,7 +68,7 @@ public:
namespace Enums
{
-/** Get a printable name for the given query type.
+/** Gets a printable name for the given query type.
*
* @param query The query type.
* @return The name of the query.
@@ -76,7 +76,7 @@ namespace Enums
Glib::ustring get_name(QueryType query);
_IGNORE(gst_query_type_get_name)
-/** Get the unique quark for the given query type.
+/** Gets the unique quark for the given query type.
*
* @param query The query type.
* @return The quark associated with the query type.
@@ -86,7 +86,7 @@ _IGNORE(gst_query_type_to_quark)
} //namespace Enums
-/** Gst::Query - Classes used to perform queries on pads and elements.
+/** A class used to perform queries on pads and elements.
*
* Queries can be created using the derived Gst::Query classes create()
* methods. Query values can be set using derived classes set() methods, and
diff --git a/gstreamer/src/registry.hg b/gstreamer/src/registry.hg
index 14a1520..32074dd 100644
--- a/gstreamer/src/registry.hg
+++ b/gstreamer/src/registry.hg
@@ -30,7 +30,7 @@ namespace Gst
class Plugin;
class PluginFeature;
-/** Gst::Registry - Abstract base class for management of Gst::Plugin objects.
+/** An abstract base class for management of Gst::Plugin objects.
* One registry holds the metadata of a set of plugins. All registries build
* the GstRegistryPool.
*
diff --git a/gstreamer/src/ringbuffer.hg b/gstreamer/src/ringbuffer.hg
index 3538515..2cd2583 100644
--- a/gstreamer/src/ringbuffer.hg
+++ b/gstreamer/src/ringbuffer.hg
@@ -33,8 +33,9 @@ _WRAP_ENUM(RingBufferState, GstRingBufferState)
_WRAP_ENUM(BufferFormat, GstBufferFormat)
_WRAP_ENUM(BufferFormatType, GstBufferFormatType)
-/** The class containing the format specification of a Gst::RingBuffer. The
- * "in" members should be specified by the caller of the
+/** A class containing the format specification of a Gst::RingBuffer.
+ * Gst::RingBufferSpec contains the format specification of a Gst::RingBuffer.
+ * The "in" members should be specified by the caller of the
* Gst::RingBuffer::acquire() method while the "in/out" members may be set by
* the caller but are also modifiable by Gst::RingBuffer::acquire(). The
* "out" members are generated as a result of the call to
@@ -250,7 +251,7 @@ protected:
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
};
-/** Gst::RingBuffer â?? Base class for audio ringbuffer implementations.
+/** A base class for audio ringbuffer implementations.
* This object is the base class for audio ringbuffers used by the base audio
* source and sink classes.
*
diff --git a/gstreamer/src/segment.hg b/gstreamer/src/segment.hg
index b6896d6..f1653eb 100644
--- a/gstreamer/src/segment.hg
+++ b/gstreamer/src/segment.hg
@@ -26,8 +26,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::Segment - Class describing the configured region of interest in a
- * media file.
+/** A class that describes the configured region of interest in a media file.
* This helper structure holds the relevant values for tracking the region of
* interest in a media file, called a segment.
*
diff --git a/gstreamer/src/streamvolume.hg b/gstreamer/src/streamvolume.hg
index daf4f61..eca6cf1 100644
--- a/gstreamer/src/streamvolume.hg
+++ b/gstreamer/src/streamvolume.hg
@@ -27,7 +27,7 @@ namespace Gst
_WRAP_ENUM(StreamVolumeFormat, GstStreamVolumeFormat)
-/** Gst::StreamVolume - Interface for elements that provide a stream volume.
+/** An interface for elements that provide a stream volume.
* @ingroup GstInterfaces
*/
diff --git a/gstreamer/src/structure.hg b/gstreamer/src/structure.hg
index a3cc7f7..c4d3af8 100644
--- a/gstreamer/src/structure.hg
+++ b/gstreamer/src/structure.hg
@@ -26,7 +26,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::Structure - Generic structure containing fields of names and values.
+/** A generic class containing fields of names and values.
* A Gst::Structure is a collection of key/value pairs. The keys are expressed
* as GQuarks and the values can be of any GType.
*
diff --git a/gstreamer/src/systemclock.hg b/gstreamer/src/systemclock.hg
index bab4d47..6cbf6a0 100644
--- a/gstreamer/src/systemclock.hg
+++ b/gstreamer/src/systemclock.hg
@@ -24,7 +24,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::SystemClock - Default clock that uses the current system time.
+/** A default clock that uses the current system time.
* The GStreamer core provides a Gst::SystemClock based on the system time.
* Asynchronous callbacks are scheduled from an internal thread.
*
diff --git a/gstreamer/src/taglist.hg b/gstreamer/src/taglist.hg
index cffe2b7..7fe54d4 100644
--- a/gstreamer/src/taglist.hg
+++ b/gstreamer/src/taglist.hg
@@ -37,25 +37,25 @@ _WRAP_ENUM(TagFlag, GstTagFlag)
*/
enum Tag
{
-/** Commonly used title (string).
+/** The commonly used title (string).
* The title as it should be displayed, e.g. 'The Doll House'.
*/
TAG_TITLE,
-/** Commonly used title, as used for sorting (string).
+/** The commonly used title, as used for sorting (string).
* The title as it should be sorted, e.g. 'Doll House, The'.
*
* Since 0.10.15.
*/
TAG_TITLE_SORTNAME,
-/** Person(s) responsible for the recording (string).
+/** The person(s) responsible for the recording (string).
* The artist name as it should be displayed, e.g. 'Jimi Hendrix' or 'The
* Guitar Heroes'.
*/
TAG_ARTIST,
-/** Person(s) responsible for the recording, as used for sorting (string).
+/** The person(s) responsible for the recording, as used for sorting (string).
* The artist name as it should be sorted, e.g. 'Hendrix, Jimi' or 'Guitar
* Heroes, The'.
*
@@ -63,31 +63,31 @@ TAG_ARTIST,
*/
TAG_ARTIST_SORTNAME,
-/** Album containing this data (string).
+/** The album containing this data (string).
* The album name as it should be displayed, e.g. 'The Jazz Guitar'.
*/
TAG_ALBUM,
-/** Album containing this data, as used for sorting (string).
+/** The album containing this data, as used for sorting (string).
* The album name as it should be sorted, e.g. 'Jazz Guitar, The'.
*
* Since 0.10.15.
*/
TAG_ALBUM_SORTNAME,
-/** Date the data was created (GDate structure).
+/** The date the data was created (GDate structure).
*/
TAG_DATE,
-/** Genre this data belongs to (string).
+/** The genre this data belongs to (string).
*/
TAG_GENRE,
-/** Free text commenting the data (string).
+/** The free text commenting the data (string).
*/
TAG_COMMENT,
-/** Key/value text commenting the data (string).
+/** The Key/value text commenting the data (string).
* Must be in the form of 'key=comment' or 'key[lc]=comment' where 'lc' is an
* ISO-639 language code.
*
@@ -98,205 +98,210 @@ TAG_COMMENT,
*/
TAG_EXTENDED_COMMENT,
-/** Track number inside a collection (unsigned integer).
+/** The track number inside a collection (unsigned integer).
*/
TAG_TRACK_NUMBER,
-/** Count of tracks inside collection this track belongs to (unsigned integer).
+/** The count of tracks inside collection this track belongs to (unsigned
+ * integer).
*/
TAG_TRACK_COUNT,
-/** Disc number inside a collection (unsigned integer).
+/** The disc number inside a collection (unsigned integer).
*/
TAG_ALBUM_VOLUME_NUMBER,
-/** Count of discs inside collection this disc belongs to (unsigned integer).
+/** The count of discs inside collection this disc belongs to (unsigned
+ * integer).
*/
TAG_ALBUM_VOLUME_COUNT,
-/** Original location of file as a URI (string).
+/** The original location of file as a URI (string).
*/
TAG_LOCATION,
-/** Short text describing the content of the data (string).
+/** The short text describing the content of the data (string).
*/
TAG_DESCRIPTION,
-/** Version of this data (string).
+/** The version of this data (string).
*/
TAG_VERSION,
-/** International Standard Recording Code - see http://www.ifpi.org/isrc/
+/** The International Standard Recording Code - see http://www.ifpi.org/isrc/
* (string).
*/
TAG_ISRC,
-/** Organization (string).
+/** The organization (string).
*/
TAG_ORGANIZATION,
-/** Copyright notice of the data (string).
+/** The copyright notice of the data (string).
*/
TAG_COPYRIGHT,
-/** URI to location where copyright details can be found (string).
+/** The URI to location where copyright details can be found (string).
* Since 0.10.14.
*/
TAG_COPYRIGHT_URI,
-/** Person(s) who composed the recording (string).
+/** The person(s) who composed the recording (string).
* Since 0.10.15.
*/
TAG_COMPOSER,
-/** Contact information (string).
+/** The contact information (string).
*/
TAG_CONTACT,
-/** License of data (string).
+/** The license of the data (string).
*/
TAG_LICENSE,
-/** URI to location where license details can be found (string).
+/** The URI to the location where license details can be found (string).
* Since 0.10.14.
*/
TAG_LICENSE_URI,
-/** Person(s) performing (string).
+/** The person(s) performing (string).
*/
TAG_PERFORMER,
-/** Length in GStreamer time units (nanoseconds) (unsigned 64-bit integer).
+/** The length in GStreamer time units (nanoseconds) (unsigned 64-bit
+ * integer).
*/
TAG_DURATION,
-/** Codec the data is stored in (string).
+/** The codec the data is stored in (string).
*/
TAG_CODEC,
-/** Codec the video data is stored in (string).
+/** The codec the video data is stored in (string).
*/
TAG_VIDEO_CODEC,
-/** Codec the audio data is stored in (string).
+/** The codec the audio data is stored in (string).
*/
TAG_AUDIO_CODEC,
-/** Exact or average bitrate in bits/s (unsigned integer).
+/** The exact or average bitrate in bits/s (unsigned integer).
*/
TAG_BITRATE,
-/** Nominal bitrate in bits/s (unsigned integer).
+/** The nominal bitrate in bits/s (unsigned integer).
*/
TAG_NOMINAL_BITRATE,
-/** Minimum bitrate in bits/s (unsigned integer).
+/** The minimum bitrate in bits/s (unsigned integer).
*/
TAG_MINIMUM_BITRATE,
-/** Maximum bitrate in bits/s (unsigned integer).
+/** The maximum bitrate in bits/s (unsigned integer).
*/
TAG_MAXIMUM_BITRATE,
-/** Serial number of track (unsigned integer).
+/** The serial number of track (unsigned integer).
*/
TAG_SERIAL,
-/** Encoder used to encode this stream (string).
+/** The encoder used to encode this stream (string).
*/
TAG_ENCODER,
-/** Version of the encoder used to encode this stream (unsigned integer).
+/** The version of the encoder used to encode this stream (unsigned integer).
*/
TAG_ENCODER_VERSION,
-/** Track gain in db (double).
+/** The track gain in db (double).
*/
TAG_TRACK_GAIN,
-/** Peak of the track (double).
+/** The peak of the track (double).
*/
TAG_TRACK_PEAK,
-/** Album gain in db (double).
+/** The album gain in db (double).
*/
TAG_ALBUM_GAIN,
-/** Peak of the album (double).
+/** The peak of the album (double).
*/
TAG_ALBUM_PEAK,
-/** Reference level of track and album gain values (double).
+/** The reference level of track and album gain values (double).
* Since 0.10.12.
*/
TAG_REFERENCE_LEVEL,
-/** Language code (ISO-639-1) (string) of the content.
+/** The language code (ISO-639-1) (string) of the content.
*/
TAG_LANGUAGE_CODE,
-/** Image (buffer) (buffer caps should specify the content type and preferably
- * also set "image-type" field as GstTagImageType).
+/** The image (buffer) (buffer caps should specify the content type and
+ * preferably also set "image-type" field as GstTagImageType).
* Since 0.10.6
*/
TAG_IMAGE,
-/** Image that is meant for preview purposes, e.g.\ small icon-sized version
- * (buffer) (buffer caps should specify the content type).
+/** The image that is meant for preview purposes, e.g.\ small icon-sized
+ * version (buffer) (buffer caps should specify the content type).
* Since 0.10.7.
*/
TAG_PREVIEW_IMAGE,
-/** Generic file attachment (buffer) (buffer caps should specify the content
- * type and if possible set "filename" to the file name of the attachment).
+/** The generic file attachment (buffer) (buffer caps should specify the
+ * content type and if possible set "filename" to the file name of the
+ * attachment).
*
* Since 0.10.21.
*/
TAG_ATTACHMENT,
-/** Number of beats per minute in audio (double).
+/** The number of beats per minute in audio (double).
* Since 0.10.12.
*/
TAG_BEATS_PER_MINUTE,
-/** Comma separated keywords describing the content (string).
+/** The comma separated keywords describing the content (string).
*
* Since 0.10.21
*/
TAG_KEYWORDS,
-/** Human readable descriptive location of where the media has been recorded or
- * produced. (string).
+/** The human readable descriptive location of where the media has been
+ * recorded or produced. (string).
*
* Since 0.10.21.
*/
TAG_GEO_LOCATION_NAME,
-/** Geo latitude location of where the media has been recorded or produced in
- * degrees according to WGS84 (zero at the equator, negative values for
+/** The geo latitude location of where the media has been recorded or produced
+ * in degrees according to WGS84 (zero at the equator, negative values for
* southern latitudes) (double).
*
* Since 0.10.21.
*/
TAG_GEO_LOCATION_LATITUDE,
-/** Geo longitude location of where the media has been recorded or produced in
- * degrees according to WGS84 (zero at the prime meridian in Greenwich/UK,
- * negative values for western longitudes). (double).
+/** The geo longitude location of where the media has been recorded or
+ * produced in degrees according to WGS84 (zero at the prime meridian in
+ * Greenwich/UK, negative values for western longitudes). (double).
*
* Since 0.10.21.
*/
TAG_GEO_LOCATION_LONGITUDE,
-/** Geo elevation of where the media has been recorded or produced in meters
- * according to WGS84 (zero is average sea level) (double).
+/** The geo elevation of where the media has been recorded or produced in
+ * meters according to WGS84 (zero is average sea level) (double).
*
* Since 0.10.21.
*/
TAG_GEO_LOCATION_ELEVATION
};
-/** Output stream operator for the Gst::Tag enum (this will output a string).
+/** An Output stream operator for the Gst::Tag enum (this will output a
+ * string).
*/
std::ostream& operator<<(std::ostream& stream, Tag tag);
@@ -304,7 +309,8 @@ std::ostream& operator<<(std::ostream& stream, Tag tag);
const char* gstreamermm_get_stock_tag(Tag tag);
#endif
-/** A List of tags and values used to describe media metadata.
+/** A class tha represents a list of tags and values used to describe media
+ * metadata.
* Taglists form part of media streams and describe the content of a stream in
* a non-technical way. Examples include the author of a song, the title of
* that very same song or the album it is a part of. Tag reading is done
diff --git a/gstreamer/src/tagsetter.hg b/gstreamer/src/tagsetter.hg
index c50e1b0..090c39d 100644
--- a/gstreamer/src/tagsetter.hg
+++ b/gstreamer/src/tagsetter.hg
@@ -27,9 +27,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::TagSetter - Gst::Element interface that allows setting and retrieval
- * of media metadata.
- *
+/** An interface that allows setting and retrieval of media metadata.
* Elements that support changing a stream's metadata will implement this
* interface. Examples of such elements are 'vorbisenc', 'theoraenc' and
* 'id3v2mux'.
diff --git a/gstreamer/src/task.hg b/gstreamer/src/task.hg
index eb49f7e..24c7f17 100644
--- a/gstreamer/src/task.hg
+++ b/gstreamer/src/task.hg
@@ -30,7 +30,7 @@ _WRAP_ENUM(TaskState, GstTaskState)
class TaskPool;
-/** Gst::Task - Abstraction of GStreamer streaming threads.
+/** A class representing GStreamer streaming threads.
* Gst::Task is used by Gst::Element and Gst::Pad to provide the data passing
* threads in a Gst::Pipeline.
*
diff --git a/gstreamer/src/taskpool.hg b/gstreamer/src/taskpool.hg
index 2dc36f5..c386472 100644
--- a/gstreamer/src/taskpool.hg
+++ b/gstreamer/src/taskpool.hg
@@ -25,7 +25,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::TaskPool - Pool of GStreamer streaming threads.
+/** A class representing a pool of GStreamer streaming threads.
* This object provides an abstraction for creating threads. The default
* implementation uses a regular Glib::ThreadPool to start tasks.
*
diff --git a/gstreamer/src/tuner.hg b/gstreamer/src/tuner.hg
index 3619a94..973e303 100644
--- a/gstreamer/src/tuner.hg
+++ b/gstreamer/src/tuner.hg
@@ -28,7 +28,7 @@ namespace Gst
class TunerChannel;
class TunerNorm;
-/** Gst::Tuner - Interface for elements providing tuner operations.
+/** An interface for elements providing tuner operations.
* @ingroup GstInterfaces
*/
class Tuner : public Glib::Interface
diff --git a/gstreamer/src/tunerchannel.hg b/gstreamer/src/tunerchannel.hg
index 1c0eafa..28d13a2 100644
--- a/gstreamer/src/tunerchannel.hg
+++ b/gstreamer/src/tunerchannel.hg
@@ -26,8 +26,7 @@ namespace Gst
_WRAP_ENUM(TunerChannelFlags, GstTunerChannelFlags)
-/** Gst::TunerChannel - A channel from an element implementing the Gst::Tuner
- * interface.
+/** A channel from an element implementing the Gst::Tuner interface.
* The Gst::TunerChannel object is provided by an element implementing the
* Gst::Tuner interface.
*
diff --git a/gstreamer/src/tunernorm.hg b/gstreamer/src/tunernorm.hg
index 7de9866..dfc7daa 100644
--- a/gstreamer/src/tunernorm.hg
+++ b/gstreamer/src/tunernorm.hg
@@ -25,7 +25,7 @@ namespace Gst
class Fraction;
-/** Gst::TunerNorm - Encapsulates information about the data format(s) for a
+/** A class that encapsulates information about the data format(s) for a
* Gst::TunerChannel.
* @ingroup GstInterfaces
*/
diff --git a/gstreamer/src/typefind.hg b/gstreamer/src/typefind.hg
index 8e193d7..44e6770 100644
--- a/gstreamer/src/typefind.hg
+++ b/gstreamer/src/typefind.hg
@@ -29,7 +29,7 @@ _WRAP_ENUM(TypeFindProbability, GstTypeFindProbability)
class Caps;
class Plugin;
-/** Gst::TypeFind - Stream type detection.
+/** A class used for stream type detection.
* Gst::TypeFind methods allow you to detect the media type of an unknown
* stream.
*
diff --git a/gstreamer/src/typefindfactory.hg b/gstreamer/src/typefindfactory.hg
index 58bc8e2..2ff25b1 100644
--- a/gstreamer/src/typefindfactory.hg
+++ b/gstreamer/src/typefindfactory.hg
@@ -28,9 +28,9 @@ namespace Gst
class Caps;
class TypeFind;
-/** Gst::TypeFindFactory â?? Information about registered typefind functions.
- * These functions allow querying informations about registered typefind
- * functions.
+/** A class used to get information about registered typefind functions.
+ * The methods in this class allow querying information about registered
+ * typefind functions.
*
* Writing typefinders in C++ is not possible presently.
*
diff --git a/gstreamer/src/urihandler.hg b/gstreamer/src/urihandler.hg
index e0f9f36..206456f 100644
--- a/gstreamer/src/urihandler.hg
+++ b/gstreamer/src/urihandler.hg
@@ -30,7 +30,7 @@ class Element;
_WRAP_ENUM(URIType, GstURIType)
-/** Gst::URIHandler - An interface to ease URI handling in plugins.
+/** An interface to ease URI handling in plugins.
* The Gst::URIHandler is an interface that is implemented by Source and Sink
* Gst::Element to simplify then handling of URI.
*
diff --git a/gstreamer/src/value.hg b/gstreamer/src/value.hg
index 2029bbe..9ca0a5b 100644
--- a/gstreamer/src/value.hg
+++ b/gstreamer/src/value.hg
@@ -30,7 +30,7 @@ namespace Gst
* GST_TYPE_FRACTION, etc.
*/
-/** Represents a 4 byte identifier (used in codecs).
+/** A class that represents a 4 byte identifier (used in codecs).
* Gst::Fourcc is used to store a four byte identifier in Gst::Structure of
* Gst::Caps as a value representing a property (see GStreamer Application
* Development Manual section 8.2.2 and GstValue docs). When the value is set,
@@ -106,7 +106,7 @@ private:
};
-/** Represents a fraction.
+/** A class that represents a fraction.
* Gst::Fraction is used to store a fraction in Gst::Structures of Gst::Caps as
* a value representing a property (see GStreamer Application Development
* Manual section 8.2.2 and GstValue docs). When the value is set, it is
@@ -162,7 +162,7 @@ public:
//TODO: Use a template for IntRange, DoubleRange, FractionRange? murrayc
-/** Represents an integer range (min - max).
+/** A class that represents an integer range (min - max).
* Gst::IntRange is used to store an integer range in Gst::Structures of
* Gst::Caps as a value representing a property (see GStreamer Application
* Development Manual section 8.2.2 and GstValue docs). When the value is set,
@@ -216,7 +216,7 @@ public:
int max;
};
-/** Represents a double range (min - max).
+/** A class that represents a double range (min - max).
* Gst::DoubleRange is used to use to store a double precision floating point
* range in Gst::Structures of Gst::Caps as a value representing a property
* (see GStreamer Application Development Manual section 8.2.2 and GstValue
@@ -270,7 +270,7 @@ public:
double max;
};
-/** Represents a fractional range.
+/** A class that represents a fractional range.
* Gst::FractionRange is used to store a fractional range in Gst::Structures of
* Gst::Caps as a value representing a property (see GStreamer Application
* Development Manual section 8.2.2 and GstValue docs). When the value is set,
diff --git a/gstreamer/src/videoorientation.hg b/gstreamer/src/videoorientation.hg
index e6c69ea..c10e43a 100644
--- a/gstreamer/src/videoorientation.hg
+++ b/gstreamer/src/videoorientation.hg
@@ -25,8 +25,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Gst::VideoOrientation - Interface for elements providing video orientation
- * controls.
+/** An interface for elements providing video orientation controls.
* The interface allows unified access to control flipping and autocenter
* operation of video-sources or operators.
* @ingroup GstInterfaces
diff --git a/gstreamer/src/videosink.hg b/gstreamer/src/videosink.hg
index f226de5..5c2db5e 100644
--- a/gstreamer/src/videosink.hg
+++ b/gstreamer/src/videosink.hg
@@ -24,7 +24,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** Helper structure for the Gst::VideoSink class representing a rectangular
+/** A helper structure for the Gst::VideoSink class representing a rectangular
* area.
*/
struct VideoRectangle
@@ -42,8 +42,8 @@ struct VideoRectangle
int h;
};
-/** Gst::VideoSink - Base class for video sinks.
- * Provides useful functions and a base class for video sinks.
+/** A base class for video sinks.
+ * Gst::VideoSink provides useful functions and a base class for video sinks.
*
* Gst::VideoSink will configure the default base sink to drop frames that
* arrive later than 20ms as this is considered the default threshold for
diff --git a/gstreamer/src/xml.hg b/gstreamer/src/xml.hg
index 68f392a..32950dc 100644
--- a/gstreamer/src/xml.hg
+++ b/gstreamer/src/xml.hg
@@ -28,7 +28,7 @@ namespace Gst
class Element;
-/** Gst::XML - XML save/restore operations of pipelines.
+/** A class facilitating XML save/restore operations of pipelines.
* GStreamer pipelines can be saved to xml files using write_to_stream(). They
* can be loaded back using parse_doc() / parse_file() / parse_memory().
* Additionally one can load saved pipelines into the gst-editor to inspect
diff --git a/gstreamer/src/xoverlay.hg b/gstreamer/src/xoverlay.hg
index 3f0e0d5..024316a 100644
--- a/gstreamer/src/xoverlay.hg
+++ b/gstreamer/src/xoverlay.hg
@@ -25,8 +25,7 @@ _DEFS(gstreamermm,gst)
namespace Gst
{
-/** XOverlay - Interface for setting/getting a Window on elements supporting
- * it.
+/** An interface for setting/getting a Window on elements supporting it.
* The XOverlay interface is used for 2 main purposes :
*
* - To get a grab on the Window where the video sink element is going to
diff --git a/tools/extra_defs_gen/generate_plugin_gmmproc_file.cc b/tools/extra_defs_gen/generate_plugin_gmmproc_file.cc
index 06e4dc3..1f6d511 100644
--- a/tools/extra_defs_gen/generate_plugin_gmmproc_file.cc
+++ b/tools/extra_defs_gen/generate_plugin_gmmproc_file.cc
@@ -655,7 +655,7 @@ static void generate_hg_file(const std::string& includeMacroCalls,
if(!enumWrapStatements.empty())
std::cout << enumWrapStatements;
- std::cout << "/** " << nmspace << "::" << cppTypeName << " - " << pluginName << " plugin." << std::endl;
+ std::cout << "/** A Wrapper for the " << pluginName << " plugin." << std::endl;
std::cout << " * Please note that, though using the underlying GObject is "
"fine, using its C\n * <B>type</B> is not guaranteed to be API stable "
"across releases because it is\n * not guaranteed to always remain the "
@@ -798,10 +798,10 @@ int main(int argc, char** argv)
static const GOptionEntry optionEntries[] =
{
{"hg", 'h', 0, G_OPTION_ARG_NONE, &hgFile, "Generate preliminary .hg file.", 0 },
- {"ccg", 'c', 0, G_OPTION_ARG_NONE, &ccgFile, "Generate .ccg file.", 0 },
- {"confirm-existence", 'e', 0, G_OPTION_ARG_NONE, &confirmExistence, "Return success if the plugin exists, failure otherwise.", 0 },
+ {"ccg", 'c', 0, G_OPTION_ARG_NONE, &ccgFile, "Generate preliminary .ccg file.", 0 },
+ {"confirm-existence", 'e', 0, G_OPTION_ARG_NONE, &confirmExistence, "Returns success if the plugin exists.", 0 },
{"namespace", 'n', 0, G_OPTION_ARG_STRING, &nmspace, "The namespace of the plugin.", "namespace" },
- {"main-defs", 'm', 0, G_OPTION_ARG_STRING, &defsFile, "The main defs file without .defs extension.", "def" },
+ {"main-defs", 'm', 0, G_OPTION_ARG_STRING, &defsFile, "The main defs file (no .defs extension).", "def" },
{"target", 't', 0, G_OPTION_ARG_STRING, &target, "The .h and .cc target directory.", "directory" },
{ 0, '\0', 0, G_OPTION_ARG_NONE, 0, 0, 0 }
};
@@ -810,10 +810,12 @@ int main(int argc, char** argv)
g_option_context_new("<plugin-name> [CppPluginClassName]");
g_option_context_set_summary(gContext, "Outputs a GStreamer plugin's "
"gmmproc files to be processed by gmmproc for\nwrapping in gstreamermm. "
- "Use the same syntax for plugin-name as in gst-inspect\nand supply the "
- "desired C++ class name unless the --confirm-existence option is\nused. "
- "The .hg file is a preliminary .hg file that needs to be run through "
- "m4\nincluding the macros in the plugingen*.m4 files.");
+ "Use the same syntax for the plugin name as in\ngst-inspect and supply "
+ "the desired C++ class name unless the\n--confirm-existence option is "
+ "used. The generated files are preliminary\nfiles that need to be run "
+ "through m4 including the macros in the\nplugingen*.m4 files to get the "
+ "final .hg or .ccg file."
+ );
g_option_context_add_main_entries(gContext, optionEntries, 0);
g_option_context_add_group(gContext, gst_init_get_option_group());
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
