gnomemm r1469 - in gstreamermm/trunk: . gstreamer/gstreamermm gstreamer/src tools/m4

[jaalburqu svn gnome org]

Author: jaalburqu
Date: Fri Apr 18 03:24:17 2008
New Revision: 1469
URL: http://svn.gnome.org/viewvc/gnomemm?rev=1469&view=rev

Log:
2008-04-17  Josà Alburquerque  <jaalburqu svn gnome org>

	Fully qualified Gst classes in doc blocks of following (and all *.hg
	files in this commit):
	* gstreamer/src/registry.hg:
	* gstreamer/src/segment.hg:
	* gstreamer/src/systemclock.hg:
	* gstreamer/src/tagsetter.hg:
	* gstreamer/src/task.hg:
	* gstreamer/src/urihandler.hg:
	* gstreamer/src/value.hg: 

	* gstreamer/src/structure.hg: Added docs for handwritten method
	foreach()
	* tools/m4/class_boxedtype_ncopy.m4: Modified to generate docs for
	set_destroy() generated wrapper method

	* gstreamer/src/taglist.hg: Added docs for handwritten method
	foreach()
	* gstreamer/gstreamermm/taglist.h: Regenerated through build process
	by adding (and then removing) taglist.hg to
	Makefile_list_of_hg.am_fragment and removing top extern "C" {...}
	section
	* tools/m4/class_boxedtype_ncopy_extra.m4: Modified to generate docs
	for set_destroy() generated wrapper method

Modified:
   gstreamermm/trunk/ChangeLog
   gstreamermm/trunk/gstreamer/gstreamermm/taglist.h
   gstreamermm/trunk/gstreamer/src/registry.hg
   gstreamermm/trunk/gstreamer/src/segment.hg
   gstreamermm/trunk/gstreamer/src/structure.hg
   gstreamermm/trunk/gstreamer/src/systemclock.hg
   gstreamermm/trunk/gstreamer/src/taglist.hg
   gstreamermm/trunk/gstreamer/src/tagsetter.hg
   gstreamermm/trunk/gstreamer/src/task.hg
   gstreamermm/trunk/gstreamer/src/urihandler.hg
   gstreamermm/trunk/gstreamer/src/value.hg
   gstreamermm/trunk/tools/m4/class_boxedtype_ncopy.m4
   gstreamermm/trunk/tools/m4/class_boxedtype_ncopy_extra.m4

Modified: gstreamermm/trunk/gstreamer/gstreamermm/taglist.h
==============================================================================
--- gstreamermm/trunk/gstreamer/gstreamermm/taglist.h	(original)
+++ gstreamermm/trunk/gstreamer/gstreamermm/taglist.h	Fri Apr 18 03:24:17 2008
@@ -105,7 +105,7 @@
 {
 
 
-/** TagList â List of tags and values used to describe media metadata.
+/** Gst::TagList â List of tags and values used to describe media metadata.
  */
 class TagList
 {
@@ -137,7 +137,11 @@
   ///Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
   GstTagList* gobj_copy() const;
 
-  //Change whether wrapper should destroy gobject or not when wrapper is deleted.
+  /** Change whether the wrapper should destroy the underlying gobject or not
+   * when the wrapper is deleted.
+   * @param destroy whether or not the wrapper should destroy the underlying
+   * gobject when it is destroyed
+   */
   void set_destroy(bool destroy);
 
 protected:
@@ -151,7 +155,7 @@
 
 public:
   /** For example,
-   * void on_foreach(const TagList& taglist, const Glib::Ustring& tag);
+   * void on_foreach(const Gst::TagList& taglist, const Glib::Ustring& tag);
    */
   typedef sigc::slot<void, const TagList&, const Glib::ustring&> SlotForeach;
 
@@ -214,6 +218,11 @@
    */
   TagList merge(const TagList& other, TagMergeMode mode);
 
+  /** Calls the given slot for each tag inside the tag list. Note that if there
+   * is no tag, the slot won't be called at all.
+   *
+   * @param slot slot to be called for each tag
+   */
   void foreach(const SlotForeach& slot);
 
 

Modified: gstreamermm/trunk/gstreamer/src/registry.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/registry.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/registry.hg	Fri Apr 18 03:24:17 2008
@@ -32,17 +32,17 @@
 class Plugin;
 class PluginFeature;
 
-/** Registry â Abstract base class for management of Plugin objects.
+/** Gst::Registry â Abstract base class for management of Gst::Plugin objects.
   * One registry holds the metadata of a set of plugins. All registries build
   * the GstRegistryPool.
   *
   * Design:
   *
-  * The Registry object is a list of plugins and some functions for dealing
-  * with them. Plugins are matched 1-1 with a file on disk, and may or may
-  * not be loaded at a given time. There may be multiple Registry objects,
-  * but the "default registry" is the only object that has any meaning to the
-  * core.
+  * The Gst::Registry object is a list of plugins and some functions for
+  * dealing with them. Gst::Plugins are matched 1-1 with a file on disk, and
+  * may or may not be loaded at a given time. There may be multiple
+  * Gst::Registry objects, but the "default registry" is the only object that
+  * has any meaning to the core.
   *
   * The registry.xml file is actually a cache of plugin information. This is
   * unlike versions prior to 0.10, where the registry file was the primary
@@ -115,7 +115,7 @@
    *
    * @param filter the filter to use
    * @param first only return first match
-   * @return a List of Plugin. MT safe.
+   * @return a List of Gst::Plugin. MT safe.
    *
    */
   Glib::ListHandle< Glib::RefPtr<Plugin> > get_plugin_list(const Plugin::SlotFilter& filter, bool first);
@@ -127,7 +127,7 @@
    * @param registry registry to query
    * @param filter the filter to use
    * @param first only return first match
-   * @return a List of plugin features. MT safe.
+   * @return a List of Gst::PluginFeature. MT safe.
    */
   Glib::ListHandle< Glib::RefPtr<PluginFeature> > get_feature_list(const PluginFeature::SlotFilter& filter, bool first);
 
@@ -142,14 +142,14 @@
 #ifdef USE_BINARY_REGISTRY
   /** Read the contents of the binary cache file at location into registry.
    *
-   * @param location : 	a filename
+   * @param location a filename
    * @return TRUE on success.
    */
   bool binary_read_cache(const Glib::ustring& location);
 
   /** Write the registry to a cache to file at given location.
    *
-   * @param location : 	a filename
+   * @param location a filename
    * @return TRUE on success.
    */
   void binary_write_cache(const Glib::ustring& location);
@@ -164,8 +164,8 @@
   /** Write registry in an XML format at the location given by location.
    * Directories are automatically created.
    *
-   * @param location : 	a filename
-   * @return Returns : 	TRUE on success.
+   * @param location a filename
+   * @return TRUE on success.
    */
   bool xml_write_cache(const Glib::ustring& location);
 #endif
@@ -175,7 +175,14 @@
   _WRAP_METHOD(void add_feature(const Glib::RefPtr<PluginFeature>& feature), gst_registry_add_feature)
   _WRAP_METHOD(static bool check_feature_version(const Glib::ustring& feature_name, guint min_major, guint min_minor, guint min_micro), gst_default_registry_check_feature_version)
 
+  /** Signals that a feature has been added to the registry (possibly replacing
+   * a previously-added one by the same name)
+   */
   _WRAP_SIGNAL(void feature_added(const Glib::RefPtr<PluginFeature>& feature), "feature-added")
+
+  /** Signals that a plugin has been added to the registry (possibly replacing
+   * a previously-added one by the same name)
+   */
   _WRAP_SIGNAL(void plugin_added(const Glib::RefPtr<Plugin>& plugin), "plugin-added")
 
   _IGNORE(gst_registry_feature_filter,

Modified: gstreamermm/trunk/gstreamer/src/segment.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/segment.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/segment.hg	Fri Apr 18 03:24:17 2008
@@ -28,7 +28,7 @@
 namespace Gst
 {
 
-/** Segment â Class describing the configured region of interest in a
+/** Gst::Segment â Class describing 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.
@@ -64,10 +64,10 @@
  * For elements that perform seeks, the current segment should be updated with
  * the set_seek() and the values from the seek event. This method will update
  * all the segment fields. The last_stop field will contain the new playback
- * position. If the cur_type was different from SEEK_TYPE_NONE, playback
+ * position. If the cur_type was different from Gst::SEEK_TYPE_NONE, playback
  * continues from the last_stop position, possibly with updated flags or rate.
  *
- * For elements that want to use Segment to track the playback region, use
+ * For elements that want to use Gst::Segment to track the playback region, use
  * set_newsegment() to update the segment fields with the information from the
  * newsegment event. The clip() method can be used to check and clip the media
  * data to the segment boundaries.

Modified: gstreamermm/trunk/gstreamer/src/structure.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/structure.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/structure.hg	Fri Apr 18 03:24:17 2008
@@ -28,18 +28,18 @@
 namespace Gst
 {
 
-/** Structure â Generic structure containing fields of names and values.
- * A Structure is a collection of key/value pairs. The keys are expressed as
- * GQuarks and the values can be of any GType.
+/** Gst::Structure â Generic structure 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.
  *
- * In addition to the key/value pairs, a Structure also has a name. The name
- * starts with a letter and can be folled by letters, numbers and any of
+ * In addition to the key/value pairs, a Gst::Structure also has a name. The
+ * name starts with a letter and can be folled by letters, numbers and any of
  * "/-_.:".
  *
- * Structure is used by various GStreamer subsystems to store information in a
- * flexible and extensible way. A Structure does not have a refcount because it
- * usually is part of a higher level object such as Caps. It provides a means
- * to enforce mutability using the refcount of the parent.
+ * Gst::Structure is used by various GStreamer subsystems to store information
+ * in a flexible and extensible way. A Gst::Structure does not have a refcount
+ * because it usually is part of a higher level object such as Gst::Caps. It
+ * provides a means to enforce mutability using the refcount of the parent.
  *
  * Last reviewed on 2007-10-16 (0.10.15)
  */
@@ -79,7 +79,7 @@
 
   /** Sets the field with the given name field to value. If the field does not
    * exist, it is created. If the field exists, the previous value is replaced
-   * and freed. Returns this Structure for continued setting convenience.
+   * and freed. Returns this Gst::Structure for continued setting convenience.
    * Please note that when setting special GStreamer fields such as
    * Glib::Value<Gst::IntRange> and Glib::Value<Gst::Fraction> (using classes
    * in value.h) they are converted to the GStreamer GTypes and thus when
@@ -88,22 +88,29 @@
    *
    * @param fieldname the name of the field to set
    * @param value the new value of the field 
-   * @return this Structure
+   * @return this Gst::Structure
    */
   Structure& set_field(const Glib::ustring& fieldname, const Glib::ValueBase& value);
 
   /** Removes the field with the given name. If the field with the given name
-   * does not exist, the structure is unchanged. Returns this Structure for
-   * continued setting convenience.
+   * does not exist, the structure is unchanged. Returns this Gst::Structure
+   * for continued setting convenience.
    *
    * @param fieldname the name of the field to remove
-   * @return this Structure
+   * @return this Gst::Structure
    */
   Structure& remove_field(const Glib::ustring& fieldname);
 
   _WRAP_METHOD(void remove_all_fields(), gst_structure_remove_all_fields)
   _WRAP_METHOD(GType get_field_type(const Glib::ustring& fieldname) const, gst_structure_get_field_type)
 
+  /** Calls the provided slot once for each field in the Gst::Structure. The
+   * slot must not modify the fields. Also see map_in_place().
+   *
+   * @param slot a slot to call for each field
+   * @return TRUE if the supplied slot returns TRUE For each of the fields,
+   * FALSE otherwise.
+   */
   bool foreach(const SlotForeach& slot);
 
   _WRAP_METHOD(int size() const, gst_structure_n_fields)
@@ -187,15 +194,15 @@
    */
   bool get_date(const Glib::ustring& fieldname, Glib::Date& value) const;
 
-  /** Sets the GValue of value to the ClockTime value of the given field.
+  /** Sets the GValue of value to the Gst::ClockTime value of the given field.
    * Caller is responsible for making sure the field exists and has the correct
    * type.
    *
    * @param fieldname the name of a field
    * @param value the Value class to set
    * @return TRUE if the value could be set correctly. If there was no field
-   * with fieldname or the existing field did not contain a ClockTime, this
-   * function returns FALSE returns FALSE
+   * with fieldname or the existing field did not contain a Gst::ClockTime,
+   * this function returns FALSE returns FALSE
    */
   bool get_clock_time(const Glib::ustring& fieldname, Glib::ValueBase& value) const;
 
@@ -210,20 +217,21 @@
    */
   bool get_enum(const Glib::ustring& fieldname, GType enumtype, Glib::ValueBase& value) const;
 
-  /** Sets the GValue of value to the Fraction value of the given field. Caller
-   * is responsible for making sure the field exists and has the correct type.
+  /** Sets the GValue of value to the Gst::Fraction value of the given field.
+   * Caller is responsible for making sure the field exists and has the correct
+   * type.
    *
    * @param fieldname the name of a field
-   * @param fraction the Fraction class to set
+   * @param fraction the Gst::Fraction class to set
    * @return TRUE if the value could be set correctly. If there was no field
-   * with fieldname or the existing field did not contain a Fraction, this
+   * with fieldname or the existing field did not contain a Gst::Fraction, this
    * function returns FALSE returns FALSE
    */
   bool get_fraction(const Glib::ustring& fieldname, Gst::Fraction& fraction) const;
 
-  /** Calls the provided slot once for each field in the Structure. In contrast
-   * to foreach(), the function may modify but not delete the fields. The
-   * structure must be mutable.
+  /** Calls the provided slot once for each field in the Gst::Structure. In
+   * contrast to foreach(), the function may modify but not delete the fields.
+   * The structure must be mutable.
    *
    * @param slot a slot to call for each field
    * @return TRUE if the supplied slot returns TRUE For each of the fields,

Modified: gstreamermm/trunk/gstreamer/src/systemclock.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/systemclock.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/systemclock.hg	Fri Apr 18 03:24:17 2008
@@ -26,11 +26,11 @@
 namespace Gst
 {
 
-/** SystemClock â Default clock that uses the current system time.
- * The GStreamer core provides a SystemClock based on the system time.
+/** Gst::SystemClock â 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.
  *
- * Clock implementors are encouraged to subclass this systemclock as it
+ * Gst::Clock implementors are encouraged to subclass this systemclock as it
  * implements the async notification.
  *
  * Subclasses can however override all of the important methods for sync and

Modified: gstreamermm/trunk/gstreamer/src/taglist.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/taglist.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/taglist.hg	Fri Apr 18 03:24:17 2008
@@ -29,7 +29,7 @@
 _WRAP_ENUM(TagMergeMode, GstTagMergeMode)
 _WRAP_ENUM(TagFlag, GstTagFlag)
 
-/** TagList â List of tags and values used to describe media metadata.
+/** Gst::TagList â List of tags and values used to describe media metadata.
  */
 class TagList
 {
@@ -37,7 +37,7 @@
 
 public:
   /** For example,
-   * void on_foreach(const TagList& taglist, const Glib::Ustring& tag);
+   * void on_foreach(const Gst::TagList& taglist, const Glib::Ustring& tag);
    */
   typedef sigc::slot<void, const TagList&, const Glib::ustring&> SlotForeach;
 
@@ -51,6 +51,11 @@
   _WRAP_METHOD(void insert(const TagList& other, TagMergeMode mode), gst_tag_list_insert)
   _WRAP_METHOD(TagList merge(const TagList& other, TagMergeMode mode), gst_tag_list_merge)
 
+  /** Calls the given slot for each tag inside the tag list. Note that if there
+   * is no tag, the slot won't be called at all.
+   *
+   * @param slot slot to be called for each tag
+   */
   void foreach(const SlotForeach& slot);
 };
 

Modified: gstreamermm/trunk/gstreamer/src/tagsetter.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/tagsetter.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/tagsetter.hg	Fri Apr 18 03:24:17 2008
@@ -30,8 +30,8 @@
 
 class TagList;
 
-/** TagSetter â Element interface that allows setting and retrieval of media
- * metadata.
+/** Gst::TagSetter â Gst::Element 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
@@ -42,9 +42,9 @@
  * only for setting metadata, not for extracting it. To set tags from the
  * application, find tagsetter elements and set tags using e.g. merge_tags() or
  * add_tags(). The application should do that before the element goes to
- * STATE_PAUSED.
+ * Gst::STATE_PAUSED.
  *
- * Elements implementing the TagSetter interface often have to merge any
+ * Elements implementing the Gst::TagSetter interface often have to merge any
  * tags received from upstream and the tags set by the application via the
  * interface. This can be done like this:
  *

Modified: gstreamermm/trunk/gstreamer/src/task.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/task.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/task.hg	Fri Apr 18 03:24:17 2008
@@ -29,29 +29,29 @@
 
 _WRAP_ENUM(TaskState, GstTaskState)
 
-/** Task â Abstraction of GStreamer streaming threads.
- * Task is used by Element and Pad to provide the data passing threads in a
- * Pipeline.
- *
- * A Pad will typically start a Task to push or pull data to/from the peer
- * pads. Most source elements start a Task to push data. In some cases a
- * demuxer element can start a Task to pull data from a peer element. This is
- * typically done when the demuxer can perform random access on the upstream
- * peer element for improved performance.
- *
- * Although convenience functions exist on Pad to start/pause/stop tasks, it
- * might sometimes be needed to create a Task manually if it is not related to
- * a Pad.
+/** Gst::Task â Abstraction of GStreamer streaming threads.
+ * Gst::Task is used by Gst::Element and Gst::Pad to provide the data passing
+ * threads in a Gst::Pipeline.
+ *
+ * A Gst::Pad will typically start a Gst::Task to push or pull data to/from the
+ * peer pads. Most source elements start a Gst::Task to push data. In some
+ * cases a demuxer element can start a Gst::Task to pull data from a peer
+ * element. This is typically done when the demuxer can perform random access
+ * on the upstream peer element for improved performance.
+ *
+ * Although convenience functions exist on Gst::Pad to start/pause/stop tasks,
+ * it might sometimes be needed to create a Gst::Task manually if it is not
+ * related to a Gst::Pad.
  *
- * Before the Task can be run, it needs a Glib::StaticRecMutex that can be set
- * with set_lock().
+ * Before the Gst::Task can be run, it needs a Glib::StaticRecMutex that can be
+ * set with set_lock().
  *
  * The task can be started, paused and stopped with start(), pause() and stop()
  * respectively.
  *
- * A Task will repeadedly call the SlotTask that was provided when creating the
- * task with create(). Before calling the function it will acquire the provided
- * lock.
+ * A Gst::Task will repeadedly call the Gst::Task::SlotTask that was provided
+ * when creating the task with create(). Before calling the function it will
+ * acquire the provided lock.
  *
  * Stopping a task with stop() will not immediatly make sure the task is not
  * running anymore. Use join() to make sure the task is completely stopped and
@@ -70,6 +70,15 @@
    */
   typedef sigc::slot<void> SlotTask;
 
+  /** Create a new Gst::Task that will repeadedly call the provided slot as a
+   * parameter. Typically the task will run in a new thread.
+   *
+   * The slot cannot be changed after the task has been created. You must
+   * create a new Gst::Task to change the slot.
+   *
+   * @param slot The Gst::Task::SlotTask to use
+   * @return A new Gst::Task. MT safe.
+   */
   static Glib::RefPtr<Task> create(const SlotTask& slot);
 
   _WRAP_METHOD(static void cleanup_all(), gst_task_cleanup_all)

Modified: gstreamermm/trunk/gstreamer/src/urihandler.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/urihandler.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/urihandler.hg	Fri Apr 18 03:24:17 2008
@@ -37,9 +37,9 @@
 
 class Element;
 
-/** UriHandler â Interface to ease URI handling in plugins.
- * The URIHandler is an interface that is implemented by Source and Sink
- * Element to simplify then handling of URI.
+/** Gst::URIHandler â 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.
  *
  * An application can use the following functions to quickly get an element
  * that handles the given URI for reading or writing (make_element_from_uri()).
@@ -68,6 +68,8 @@
   _WRAP_METHOD(bool set_uri(const Glib::ustring& uri), gst_uri_handler_set_uri)
   _WRAP_METHOD(void new_uri(const Glib::ustring& uri), gst_uri_handler_new_uri)
 
+  /** This signal is emitted when the URI of the uri handler has changed.
+   */
   _WRAP_SIGNAL(void new_uri(const Glib::ustring& uri), "new-uri")
 
   _IGNORE(gst_uri_handler_new_uri)

Modified: gstreamermm/trunk/gstreamer/src/value.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/value.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/value.hg	Fri Apr 18 03:24:17 2008
@@ -28,11 +28,12 @@
 {
 
 /** Represents a 4 byte identifier (used in codecs).
- * Fourcc is used to store a four byte identifier in Structures of 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 transformed
- * to a GStreamer GType so retrieving the value is a bit different.  The class
- * can be used in setting and getting a Structure's field like so:
+ * 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,
+ * it is transformed to a GStreamer GType so retrieving the value is a bit
+ * different.  The class can be used in setting and getting a Gst::Structure
+ * field like so:
  *
  * @code
  * Glib::Value<Gst::Fourcc> value;
@@ -52,28 +53,28 @@
 class Fourcc
 {
 public:
-  /** Construct an undefined Fourcc
+  /** Construct an undefined Gst::Fourcc
    */
   Fourcc();
 
-  /** Construct a Fourcc from 4 characters
+  /** Construct a Gst::Fourcc from 4 characters
    */
   Fourcc(char first, char second, char third, char fourth);
 
-  /** Construct a Fourcc from an input string. Caller is responsible for
+  /** Construct a Gst::Fourcc from an input string. Caller is responsible for
    * ensuring the input string consists of at least four characters.
    */
   Fourcc(const Glib::ustring& s);
 
-  /** Construct a Fourcc from a 32 bit unsigned integer
+  /** Construct a Gst::Fourcc from a 32 bit unsigned integer
    */
   Fourcc(guint32 fourcc);
 
-  /** Construct a Fourcc from another
+  /** Construct a Gst::Fourcc from another
    */
   Fourcc(const Fourcc& f);
 
-  /** Cosntruct a Fourcc from a GST_TYPE_FOURCC
+  /** Cosntruct a Gst::Fourcc from a GST_TYPE_FOURCC
    */
   Fourcc(const Glib::ValueBase& gst_fraction_value);
 
@@ -94,11 +95,11 @@
 };
 
 /** Represents a fraction.
- * Fraction is used to store a fraction in Structures of 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 transformed
- * to a GStreamer GType so retrieving the value is a bit different.  The class
- * can be used in setting and getting a Structure's field like so:
+ * 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
+ * transformed to a GStreamer GType so retrieving the value is a bit different.
+ * The class can be used in setting and getting a Gst::Structure field like so:
  *
  * @code
  * Glib::Value<Gst::Fraction> value;
@@ -118,19 +119,19 @@
 class Fraction
 {
 public:
-  /** Constructs a zero Fraction (0/1)
+  /** Constructs a zero Gst::Fraction (0/1)
    */
   Fraction();
 
-  /** Constructs a Fraction (num/denom)
+  /** Constructs a Gst::Fraction (num/denom)
    */
   Fraction(int num, int denom);
 
-  /** Constructs a Fraction from another
+  /** Constructs a Gst::Fraction from another
    */
   Fraction(const Fraction& f);
 
-  /** Constructs a Fraction from a GST_TYPE_FRACTION
+  /** Constructs a Gst::Fraction from a GST_TYPE_FRACTION
    */
   Fraction(const Glib::ValueBase& gst_fraction_value);
 
@@ -140,11 +141,12 @@
 };
 
 /** Represents an integer range (min - max).
- * IntRange is used to store an integer range in Structures of 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 transformed
- * to a GStreamer GType so retrieving the value is a bit different.  The class
- * can be used in setting and getting a Structure's field like so:
+ * 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,
+ * it is transformed to a GStreamer GType so retrieving the value is a bit
+ * different.  The class can be used in setting and getting a Gst::Structure
+ * field like so:
  *
  * @code
  * Glib::Value<Gst::IntRange> value;
@@ -164,19 +166,19 @@
 class IntRange
 {
 public:
-  /** Constructs a zero IntRange (0 - 0)
+  /** Constructs a zero Gst::IntRange (0 - 0)
    */
   IntRange();
 
-  /** Constructs an IntRange (min - max)
+  /** Constructs an Gst::IntRange (min - max)
    */
   IntRange(int min, int max);
 
-  /** Constructs an IntRange from another
+  /** Constructs an Gst::IntRange from another
    */
   IntRange(const IntRange& r);
 
-  /** Constructs an IntRange from a GST_TYPE_INT_RANGE
+  /** Constructs an Gst::IntRange from a GST_TYPE_INT_RANGE
    */
   IntRange(const Glib::ValueBase& gst_int_range_value);
 
@@ -186,12 +188,12 @@
 };
 
 /** Represents a double range (min - max).
- * DoubleRange is used to use to store a double precision floating point range
- * in Structures of 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 transformed to a GStreamer GType so retrieving the value
- * is a bit different.  The class can be used in setting and getting a
- * Structure's field like so:
+ * 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
+ * docs).  When the value is set, it is transformed to a GStreamer GType so
+ * retrieving the value is a bit different.  The class can be used in setting
+ * and getting a Gst::Structure field like so:
  *
  * @code
  * Glib::Value<Gst::DoubleRange> value;
@@ -211,19 +213,19 @@
 class DoubleRange
 {
 public:
-  /** Constructs a zero DoubleRange (0.0 - 0.0)
+  /** Constructs a zero Gst::DoubleRange (0.0 - 0.0)
    */
   DoubleRange();
 
-  /** Constructs a DoubleRange (min - max)
+  /** Constructs a Gst::DoubleRange (min - max)
    */
   DoubleRange(double min, double max);
 
-  /** Constructs a DoubleRange from another
+  /** Constructs a Gst::DoubleRange from another
    */
   DoubleRange(const DoubleRange& r);
 
-  /** Constructs a DoubleRange from a GST_TYPE_DOUBLE_RANGE
+  /** Constructs a Gst::DoubleRange from a GST_TYPE_DOUBLE_RANGE
    */
   DoubleRange(const Glib::ValueBase& gst_double_range_value);
 
@@ -233,11 +235,12 @@
 };
 
 /** Represents a fractional range.
- * FractionRange is used to store a fractional range in Structures of 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 transformed
- * to a GStreamer GType so retrieving the value is a bit different.  The class
- * can be used in setting and getting a Structure's field like so:
+ * 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,
+ * it is transformed to a GStreamer GType so retrieving the value is a bit
+ * different.  The class can be used in setting and getting a Gst::Structure
+ * field like so:
  *
  * @code
  * Glib::Value<Gst::FractionRange> value;
@@ -257,19 +260,19 @@
 class FractionRange
 {
 public:
-  /** Constructs a zero FractionRange (0/1 - 0/1)
+  /** Constructs a zero Gst::FractionRange (0/1 - 0/1)
    */
   FractionRange();
 
-  /** Constructs a FractionRange (min - max)
+  /** Constructs a Gst::FractionRange (min - max)
    */
   FractionRange(const Fraction& min, const Fraction& max);
 
-  /** Constructs a FractionRange from another
+  /** Constructs a Gst::FractionRange from another
    */
   FractionRange(const FractionRange& r);
 
-  /** Constructs a FractionRange from a GST_TYPE_FRACTION_RANGE
+  /** Constructs a Gst::FractionRange from a GST_TYPE_FRACTION_RANGE
    */
   FractionRange(const Glib::ValueBase& gst_fraction_range_value);
 

Modified: gstreamermm/trunk/tools/m4/class_boxedtype_ncopy.m4
==============================================================================
--- gstreamermm/trunk/tools/m4/class_boxedtype_ncopy.m4	(original)
+++ gstreamermm/trunk/tools/m4/class_boxedtype_ncopy.m4	Fri Apr 18 03:24:17 2008
@@ -222,7 +222,11 @@
   ///Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
   __CNAME__* gobj_copy() const;
 
-  //Change whether wrapper should destroy gobject or not when wrapper is deleted.
+  /** Change whether the wrapper should destroy the underlying gobject or not
+   * when the wrapper is deleted.
+   * @param destroy whether or not the wrapper should destroy the underlying
+   * gobject when it is destroyed
+   */
   void set_destroy(bool destroy);
 
 protected:

Modified: gstreamermm/trunk/tools/m4/class_boxedtype_ncopy_extra.m4
==============================================================================
--- gstreamermm/trunk/tools/m4/class_boxedtype_ncopy_extra.m4	(original)
+++ gstreamermm/trunk/tools/m4/class_boxedtype_ncopy_extra.m4	Fri Apr 18 03:24:17 2008
@@ -227,7 +227,11 @@
   ///Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
   __CNAME__* gobj_copy() const;
 
-  //Change whether wrapper should destroy gobject or not when wrapper is deleted.
+  /** Change whether the wrapper should destroy the underlying gobject or not
+   * when the wrapper is deleted.
+   * @param destroy whether or not the wrapper should destroy the underlying
+   * gobject when it is destroyed
+   */
   void set_destroy(bool destroy);
 
 protected: