GNOME.org
 

gnomemm r1516 - in gstreamermm/trunk: . examples/media_player_gtkmm gstreamer/gstreamermm gstreamer/src

Author: jaalburqu
Date: Wed May 21 04:09:34 2008
New Revision: 1516
URL: http://svn.gnome.org/viewvc/gnomemm?rev=1516&view=rev

Log:
2008-05-21  Josà Alburquerque  <jaalburqu svn gnome org>

	* examples/media_player_gtkmm/player_window.h: Added comment on
	video_sink constructor parameter
	* gstreamer/gstreamermm/init.h:
	* gstreamer/gstreamermm/version.h:
	* gstreamer/gstreamermm/wrap.cc:
	* gstreamer/src/bin.hg:
	* gstreamer/src/element.hg:
	* gstreamer/src/filter.hg:
	* gstreamer/src/message.ccg:
	* gstreamer/src/pad.ccg:
	* gstreamer/src/pad.hg:
	* gstreamer/src/registry.hg:
	* gstreamer/src/structure.hg: Changed TRUE/FALSE to true/false;
	Capitalized first letter of @param descriptions

Modified:
   gstreamermm/trunk/ChangeLog
   gstreamermm/trunk/examples/media_player_gtkmm/player_window.h
   gstreamermm/trunk/gstreamer/gstreamermm/init.h
   gstreamermm/trunk/gstreamer/gstreamermm/version.h
   gstreamermm/trunk/gstreamer/gstreamermm/wrap.cc
   gstreamermm/trunk/gstreamer/src/bin.hg
   gstreamermm/trunk/gstreamer/src/element.hg
   gstreamermm/trunk/gstreamer/src/filter.hg
   gstreamermm/trunk/gstreamer/src/message.ccg
   gstreamermm/trunk/gstreamer/src/pad.ccg
   gstreamermm/trunk/gstreamer/src/pad.hg
   gstreamermm/trunk/gstreamer/src/registry.hg
   gstreamermm/trunk/gstreamer/src/structure.hg

Modified: gstreamermm/trunk/examples/media_player_gtkmm/player_window.h
==============================================================================
--- gstreamermm/trunk/examples/media_player_gtkmm/player_window.h	(original)
+++ gstreamermm/trunk/examples/media_player_gtkmm/player_window.h	Wed May 21 04:09:34 2008
@@ -37,7 +37,7 @@
 public:
   /**
    * @param playbin The pipeline that can play media files.
-   * @param video_sink
+   * @param video_sink The video sink to use to display stream video (if any)
    */
   PlayerWindow(const Glib::RefPtr<Gst::Pipeline>& playbin, const Glib::RefPtr<Gst::Element>& video_sink);
   virtual ~PlayerWindow();

Modified: gstreamermm/trunk/gstreamer/gstreamermm/init.h
==============================================================================
--- gstreamermm/trunk/gstreamer/gstreamermm/init.h	(original)
+++ gstreamermm/trunk/gstreamer/gstreamermm/init.h	Wed May 21 04:09:34 2008
@@ -43,15 +43,15 @@
  * functions in other glib-style libraries, such as gtk_init(). In particular,
  * unknown command line options cause this function to abort program execution.
  *
- * @param argc pointer to application's argc
- * @param argv pointer to application's argv
+ * @param argc Pointer to application's argc
+ * @param argv Pointer to application's argv
  */
 void init(int& argc, char**& argv);
 
 /** Initializes the GStreamer library, setting up internal path lists,
  * registering built-in elements, and loading standard plugins.
  *
- * This function will return FALSE if GStreamer could not be initialized for
+ * This function will return false if GStreamer could not be initialized for
  * some reason. If you want your program to fail fatally, use Gst::init()
  * instead.
  *
@@ -59,9 +59,9 @@
  * this is not an option, your program must initialise the GLib thread system
  * using g_thread_init() before any other GLib functions are called.
  *
- * @param argc pointer to application's argc
- * @param argv pointer to application's argv
- * @return TRUE if GStreamer could be initialized.
+ * @param argc Pointer to application's argc
+ * @param argv Pointer to application's argv
+ * @return true if GStreamer could be initialized.
  * @throw Glib::Error
  */
 #ifdef GLIBMM_EXCEPTIONS_ENABLED
@@ -81,7 +81,7 @@
  * If you use this function, you should make sure you initialise the GLib
  * threading system as one of the very first things in your program.
  *
- * @return a pointer to GStreamer's option group.
+ * @return A pointer to GStreamer's option group.
  */
 Glib::OptionGroup get_option_group();
   

Modified: gstreamermm/trunk/gstreamer/gstreamermm/version.h
==============================================================================
--- gstreamermm/trunk/gstreamer/gstreamermm/version.h	(original)
+++ gstreamermm/trunk/gstreamer/gstreamermm/version.h	Wed May 21 04:09:34 2008
@@ -27,9 +27,9 @@
 
   /** Gets the version number of the gstreamermm library.
    *
-   * @param major pointer to a guint to store the major version number
-   * @param minor pointer to a guint to store the minor version number
-   * @param micro pointer to a guint to store the micro version number
+   * @param major Pointer to a guint to store the major version number
+   * @param minor Pointer to a guint to store the minor version number
+   * @param micro Pointer to a guint to store the micro version number
    */
   void version(guint& major, guint& minor, guint& micro);
 

Modified: gstreamermm/trunk/gstreamer/gstreamermm/wrap.cc
==============================================================================
--- gstreamermm/trunk/gstreamer/gstreamermm/wrap.cc	(original)
+++ gstreamermm/trunk/gstreamer/gstreamermm/wrap.cc	Wed May 21 04:09:34 2008
@@ -120,7 +120,7 @@
   guint n_ifaces = 0;
   GType *ifaces = g_type_interfaces (implementer_type, &n_ifaces);
 
-  gboolean found = FALSE;
+  gboolean found = false;
   while (n_ifaces-- && !found)
   {
     found = (ifaces[n_ifaces] == interface_type);

Modified: gstreamermm/trunk/gstreamer/src/bin.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/bin.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/bin.hg	Wed May 21 04:09:34 2008
@@ -116,9 +116,9 @@
  * the bin, the query fails.
  *
  * A Gst::Bin will by default forward any event sent to it to all sink
- * elements. If all the sinks return TRUE, the bin will also return TRUE, else
+ * elements. If all the sinks return true, the bin will also return true, else
  * false is returned. If no sinks are in the bin, the event handler will return
- * TRUE.
+ * true.
  *
  * Last reviewed on 2006-04-28 (0.10.6)
  */

Modified: gstreamermm/trunk/gstreamer/src/element.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/element.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/element.hg	Wed May 21 04:09:34 2008
@@ -106,9 +106,9 @@
  *
  * You can get and set a Clock on an element using get_clock() and set_clock().
  * Some elements can provide a clock for the pipeline if provides_clock()
- * returns TRUE. With the provide_clock() method one can retrieve the clock
+ * returns true. With the provide_clock() method one can retrieve the clock
  * provided by such an element. Not all elements require a clock to operate
- * correctly. If requires_clock() returns TRUE, a clock should be set on the
+ * correctly. If requires_clock() returns true, a clock should be set on the
  * element with set_clock().
  *
  * Note that clock slection and distribution is normally handled by the
@@ -224,7 +224,7 @@
    *
    * @param format a pointer to the Gst::Format asked for. On return will
    * contain the Gst::Format used.
-   * @return TRUE if the query could be performed.
+   * @return true if the query could be performed.
    */
   bool query_position(Format& format) const;
 
@@ -234,7 +234,7 @@
    *
    * @param format a pointer to the Gst::Format asked for. On return contains
    * the Gst::Format used.
-   * @return TRUE if the query could be performed.
+   * @return true if the query could be performed.
    */
   bool query_duration(Format& format) const;
 
@@ -248,7 +248,7 @@
    * This function takes owership of the provided event.
    *
    * @param event the Gst::Event to send to the element.
-   * @return TRUE if the event was handled. MT safe. 
+   * @return true if the event was handled. MT safe. 
    */
   bool send_event(const Glib::RefPtr<Event>& event);
 

Modified: gstreamermm/trunk/gstreamer/src/filter.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/filter.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/filter.hg	Wed May 21 04:09:34 2008
@@ -38,13 +38,13 @@
 
   /**
    * Iterates over the elements in the list, calling the slot with each
-   * object.  If the slot returns TRUE, the object is
+   * object.  If the slot returns true, the object is
    * prepended to the list of results returned.  If first is true,
    * the search is halted after the first result is found.
    *
-   * @param list a list of objects
-   * @param slot the slot to execute for each item
-   * @param first flag to stop execution after a successful item
+   * @param list A list of objects
+   * @param slot The slot to execute for each item
+   * @param first Flag to stop execution after a successful item
    *
    * @return the list of results
    */

Modified: gstreamermm/trunk/gstreamer/src/message.ccg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/message.ccg	(original)
+++ gstreamermm/trunk/gstreamer/src/message.ccg	Wed May 21 04:09:34 2008
@@ -73,7 +73,7 @@
 void MessageClockProvide::parse(Glib::RefPtr<Clock>& clock, bool& ready)
 {
   GstClock* cclock = 0;
-  gboolean ready_ = FALSE;
+  gboolean ready_ = false;
   gst_message_parse_clock_provide(gobj(), &cclock, &ready_);
   clock = Glib::wrap(cclock);
   ready = ready_;

Modified: gstreamermm/trunk/gstreamer/src/pad.ccg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/pad.ccg	(original)
+++ gstreamermm/trunk/gstreamer/src/pad.ccg	Wed May 21 04:09:34 2008
@@ -69,7 +69,7 @@
     Glib::exception_handlers_invoke();
   }
 
-  return TRUE; // Keep data
+  return true; // Keep data
   #endif //GLIBMM_EXCEPTIONS_ENABLED
 }
 

Modified: gstreamermm/trunk/gstreamer/src/pad.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/pad.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/pad.hg	Wed May 21 04:09:34 2008
@@ -90,7 +90,7 @@
   /** For example,
    * bool on_have_data(const Glib::RefPtr<Gst::Pad>& pad, const
    * Glib::RefPtr<Gst::MiniObjec>& data);
-   * The on_have_data method should return TRUE to keep the data in the
+   * The on_have_data method should return true to keep the data in the
    * pipeline, false to drop it (throw it away)
    */
   typedef sigc::slot< bool, const Glib::RefPtr<Pad>&, const Glib::RefPtr<MiniObject>& > SlotData;
@@ -140,7 +140,7 @@
    * @param slot SlotBlock that will be called when the operation succeeds
    * @param blocked boolean indicating whether the pad should be blocked or
    * unblocked
-   * @return TRUE if the pad could be blocked. This function can fail if the
+   * @return true if the pad could be blocked. This function can fail if the
    * pad was already in the requested state. MT safe.
    */
   bool set_blocked_async(const SlotBlock& slot, bool blocked = true);
@@ -159,7 +159,7 @@
    * For sink pads, the probe function will be called before configuring the
    * sink with new caps, if any, and before calling the pad's chain function.
    *
-   * Your data probe should return TRUE to let the data continue to flow, or
+   * Your data probe should return true to let the data continue to flow, or
    * false to drop it. Dropping data is rarely useful, but occasionally comes
    * in handy with events.
    *

Modified: gstreamermm/trunk/gstreamer/src/registry.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/registry.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/registry.hg	Wed May 21 04:09:34 2008
@@ -142,30 +142,30 @@
 #ifdef USE_BINARY_REGISTRY
   /** Read the contents of the binary cache file at location into registry.
    *
-   * @param location a filename
-   * @return TRUE on success.
+   * @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
-   * @return TRUE on success.
+   * @param location A filename
+   * @return true on success.
    */
   void binary_write_cache(const Glib::ustring& location);
 #else
   /** Read the contents of the XML cache file at location into registry.
    *
-   * @param location a filename
-   * @return TRUE on success. 
+   * @param location A filename
+   * @return true on success. 
    */
   bool xml_read_cache(const Glib::ustring& location);
 
   /** Write registry in an XML format at the location given by location.
    * Directories are automatically created.
    *
-   * @param location a filename
-   * @return TRUE on success.
+   * @param location A filename
+   * @return true on success.
    */
   bool xml_write_cache(const Glib::ustring& location);
 #endif

Modified: gstreamermm/trunk/gstreamer/src/structure.hg
==============================================================================
--- gstreamermm/trunk/gstreamer/src/structure.hg	(original)
+++ gstreamermm/trunk/gstreamer/src/structure.hg	Wed May 21 04:09:34 2008
@@ -107,7 +107,7 @@
    * 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,
+   * @return true if the supplied slot returns true For each of the fields,
    * false otherwise.
    */
   bool foreach(const SlotForeach& slot);
@@ -121,7 +121,7 @@
    *
    * @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
+   * @return true if the value could be set correctly. If there was no field
    * with fieldname or the existing field did not contain a boolean, this
    * function returns false.
    */
@@ -132,7 +132,7 @@
    *
    * @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
+   * @return true if the value could be set correctly. If there was no field
    * with fieldname or the existing field did not contain an int, this function
    * returns false returns false
    */
@@ -143,7 +143,7 @@
    *
    * @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
+   * @return true if the value could be set correctly. If there was no field
    * with fieldname or the existing field did not contain an uint, this
    * function returns false returns false
    */
@@ -154,7 +154,7 @@
    *
    * @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
+   * @return true if the value could be set correctly. If there was no field
    * with fieldname or the existing field did not contain a fourc, this
    * function returns false returns false
    */
@@ -165,7 +165,7 @@
    *
    * @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
+   * @return true if the value could be set correctly. If there was no field
    * with fieldname or the existing field did not contain a double, this
    * function returns false returns false
    */
@@ -176,7 +176,7 @@
    *
    * @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
+   * @return true if the value could be set correctly. If there was no field
    * with fieldname or the existing field did not contain a string, this
    * function returns false returns false
    */
@@ -187,7 +187,7 @@
    *
    * @param fieldname the name of a field
    * @param date the Glib::Date class to set
-   * @return TRUE if the value could be set correctly. If there was no field
+   * @return true if the value could be set correctly. If there was no field
    * with fieldname or the existing field did not contain a GDate, this
    * function returns false returns false
    */
@@ -199,7 +199,7 @@
    *
    * @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
+   * @return true if the value could be set correctly. If there was no field
    * with fieldname or the existing field did not contain a Gst::ClockTime,
    * this function returns false returns false
    */
@@ -210,7 +210,7 @@
    *
    * @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
+   * @return true if the value could be set correctly. If there was no field
    * with fieldname or the existing field did not contain a enum, this
    * function returns false returns false
    */
@@ -222,7 +222,7 @@
    *
    * @param fieldname the name of a field
    * @param fraction the Gst::Fraction class to set
-   * @return TRUE if the value could be set correctly. If there was no field
+   * @return true if the value could be set correctly. If there was no field
    * with fieldname or the existing field did not contain a Gst::Fraction, this
    * function returns false returns false
    */
@@ -240,7 +240,7 @@
    * 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,
+   * @return true if the supplied slot returns true For each of the fields,
    * false otherwise.
    */
   bool map_in_place(const SlotMap& slot);
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]