gnomemm r1741 - in gstreamermm/trunk: . gstreamer/src

[jaalburqu svn gnome org]

Author: jaalburqu
Date: Mon Oct 13 03:31:28 2008
New Revision: 1741
URL: http://svn.gnome.org/viewvc/gnomemm?rev=1741&view=rev

Log:
2008-10-12  Josà Alburquerque  <jaalburqu svn gnome org>

	* gstreamer/src/xml.hg: Added signal docs.

	* gstreamer/src/bin.hg:
	* gstreamer/src/childproxy.hg:
	* gstreamer/src/clock.hg:
	* gstreamer/src/element.hg: Corrected typos in virtual method docs.

Modified:
   gstreamermm/trunk/ChangeLog
   gstreamermm/trunk/gstreamer/src/bin.hg
   gstreamermm/trunk/gstreamer/src/childproxy.hg
   gstreamermm/trunk/gstreamer/src/clock.hg
   gstreamermm/trunk/gstreamer/src/element.hg
   gstreamermm/trunk/gstreamer/src/xml.hg

Modified: gstreamermm/trunk/gstreamer/src/bin.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/bin.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/bin.hg	Mon Oct 13 03:31:28 2008
@@ -227,15 +227,15 @@
 
   _WRAP_PROPERTY("async-handling", bool)
 
-  /** method to add an element to a bin
+  /** Method to add an element to a bin.
    */
   _WRAP_VFUNC(bool add_element(const Glib::RefPtr<Element>& element), "add_element")
 
-  /** method to remove an element from a bin
+  /** Method to remove an element from a bin.
    */
   _WRAP_VFUNC(bool remove_element(const Glib::RefPtr<Element>& element), "remove_element")
 
-  /** method to handle a message from the children
+  /** Method to handle a message from the children.
    */
   _WRAP_VFUNC(void handle_message(const Glib::RefPtr<Message>& message), "handle_message")
 };

Modified: gstreamermm/trunk/gstreamer/src/childproxy.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/childproxy.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/childproxy.hg	Mon Oct 13 03:31:28 2008
@@ -94,11 +94,11 @@
    */
   _WRAP_SIGNAL(void child_removed(const Glib::RefPtr<Gst::Object>& object), "child-removed")
 
-  /** virtual method to fetch the child
+  /** Virtual method to fetch the child.
    */
   _WRAP_VFUNC(Glib::RefPtr<Gst::Object> get_child_by_index(guint index) const, "get_child_by_index")
 
-  /** virtual method to get the children count
+  /** Virtual method to get the children count.
    */
   _WRAP_VFUNC(guint get_children_count() const, "get_children_count")
 };

Modified: gstreamermm/trunk/gstreamer/src/clock.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/clock.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/clock.hg	Mon Oct 13 03:31:28 2008
@@ -246,28 +246,28 @@
   _WRAP_PROPERTY("window-size", int)
   _WRAP_PROPERTY("window-threshold", int)
 
-  /** change the resolution of the clock. Not all values might be acceptable.
+  /** Change the resolution of the clock. Not all values might be acceptable.
    * The new resolution should be returned.
    */
   _WRAP_VFUNC(ClockTime change_resolution(ClockTime old_resolution, ClockTime new_resolution), "change_resolution")
 
-  /** get the resolution of the clock.
+  /** Get the resolution of the clock.
    */
   _WRAP_VFUNC(ClockTime get_resolution(), "get_resolution")
 
-  /** get the internal unadjusted time of the clock.
+  /** Get the internal unadjusted time of the clock.
    */
   _WRAP_VFUNC(ClockTime get_internal_time(), "get_internal_time")
 
-  /** perform an asynchronous wait for the given Gst::ClockID.
+  /** Perform an asynchronous wait for the given Gst::ClockID.
    */
   _WRAP_VFUNC(ClockReturn wait_async(const Glib::RefPtr<ClockID>& id), "wait_async")
 
-  /** unblock a blocking or async wait operation.
+  /** Unblock a blocking or async wait operation.
    */
   _WRAP_VFUNC(void unschedule(const Glib::RefPtr<ClockID>& id), "unschedule")
 
-  /** perform a blocking wait on the given Gst::ClockID and return the jitter.
+  /** Perform a blocking wait on the given Gst::ClockID and return the jitter.
    * (Since: 0.10.10)
    */
   _WRAP_VFUNC(ClockReturn wait_jitter(const Glib::RefPtr<ClockID>& id, ClockTimeDiff& jitter), "wait_jitter")

Modified: gstreamermm/trunk/gstreamer/src/element.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/element.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/element.hg	Mon Oct 13 03:31:28 2008
@@ -278,47 +278,47 @@
    */
   _WRAP_SIGNAL(void pad_removed(const Glib::RefPtr<Pad>& old_pad), "pad-removed")
 
-  /** called when a new pad is requested.
+  /** Called when a new pad is requested.
    */
   _WRAP_VFUNC(Glib::RefPtr<Pad> request_new_pad(const Glib::RefPtr<PadTemplate>& templ, const Glib::ustring& name), "request_new_pad")
 
-  /** called when a request pad is to be released
+  /** Called when a request pad is to be released.
    */
   _WRAP_VFUNC(void release_pad(const Glib::RefPtr<Pad>& pad), "release_pad")
 
-  /** get the state of the element
+  /** Get the state of the element.
    */
   _WRAP_VFUNC(StateChangeReturn get_state(State& state, State& pending, ClockTime timeout), "get_state")
 
-  /** set a new state on the element
+  /** Set a new state on the element.
    */
   _WRAP_VFUNC(StateChangeReturn set_state(State state), "set_state")
 
-  /** called by set_state to perform an incremental state change
+  /** Called by set_state to perform an incremental state change.
    */
   _WRAP_VFUNC(StateChangeReturn change_state(StateChange transition), "change_state")
 
-  /** set a Gst::Bus on the element
+  /** Set a Gst::Bus on the element.
    */
   _WRAP_VFUNC(void set_bus(const Glib::RefPtr<Bus>& bus), "set_bus")
 
-  /** gets the Gst::Clock provided by the element
+  /** Gets the Gst::Clock provided by the element.
    */
   _WRAP_VFUNC(Glib::RefPtr<Clock> provide_clock(), "provide_clock")
 
-  /** set the Gst::Clock on the element
+  /** Set the Gst::Clock on the element.
    */
   _WRAP_VFUNC(bool set_clock(const Glib::RefPtr<Clock>& clock), "set_clock")
 
-  /** get a Gst::Index on the element
+  /** Get a Gst::Index on the element.
    */
   _WRAP_VFUNC(Glib::RefPtr<Index> get_index(), "get_index")
 
-  /** set the Gst::Index of an element
+  /** Set the Gst::Index of an element.
    */
   _WRAP_VFUNC(void set_index(const Glib::RefPtr<Index>& index), "set_index")
 
-  /** send a Gst::Event to the element
+  /** Send a Gst::Event to the element.
    */
   _WRAP_VFUNC(bool send_event(const Glib::RefPtr<Event>& event), "send_event")
 
@@ -328,11 +328,11 @@
   //way the code is generated will have to be tweaked.
   //
 //#m4 _CONVERSION(`Glib::ArrayHandle<QueryType>',`const GstQueryType*',`(GstQueryType*)(($3).data())')
-  // /** get the supported GstQueryType of this element
-  // */
+  // /** Get the supported GstQueryType of this element.
+  //  */
   // _WRAP_VFUNC(Glib::ArrayHandle<QueryType> get_query_types(), "get_query_types")
 
-  /** perform a Gst::Query on the element 
+  /** Perform a Gst::Query on the element.
    */
   _WRAP_VFUNC(bool query(const Glib::RefPtr<Query>& query), "query")
 };

Modified: gstreamermm/trunk/gstreamer/src/xml.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/xml.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/xml.hg	Mon Oct 13 03:31:28 2008
@@ -92,6 +92,8 @@
   _WRAP_METHOD(static Glib::RefPtr<Element> make_element(xmlpp::Node* curr, const Glib::RefPtr<Gst::Object>& parent), gst_xml_make_element)
 
 #m4 _CONVERSION(`GstObject*',`const Glib::RefPtr<Gst::Object>&',`Glib::wrap($3, true)')
+  /** Signals that a new object has been deserialized.
+   */
   _WRAP_SIGNAL(void object_loaded(const Glib::RefPtr<Gst::Object>& object, xmlNode* xml_node), "object-loaded")
 };