gst/gsterror.c: Documents how to receive errors.

Original commit message from CVS:
* gst/gsterror.c:
Documents how to receive errors.

diff --git a/ChangeLog b/ChangeLog
index d46afc3..62bd99c 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2006-09-16  Stefan Kost  <ensonic@users.sf.net>
+
+       * gst/gsterror.c:
+          Documents how to receive errors.
+
 2006-09-15  Wim Taymans  <wim@fluendo.com>
 
        * tools/gst-launch.c: (sigint_handler_sighandler), (check_intr),

diff --git a/gst/gsterror.c b/gst/gsterror.c
index 7423e63..b021e15 100644 (file)
--- a/gst/gsterror.c
+++ b/gst/gsterror.c
@@ -44,7 +44,9 @@
  * processing.  In short, an element doesn't know what it is being used for.
  *
  * It is the application or compound element using the given element that
- * has more context about the use of the element.  The thrown errors should
+ * has more context about the use of the element. Errors can be received by
+ * listening to the #GstBus of the element/pipeline for #GstMessage objects with
+ * the type %GST_MESSAGE_ERROR or %GST_MESSAGE_WARNING. The thrown errors should
  * be inspected, and filtered if appropriate.
  *
  * An application is expected to, by default, present the user with a
@@ -92,6 +94,8 @@
  *     passed.  #GST_ERROR_SYSTEM can be used as a shortcut to give
  *     debug information on a system call error.</para></listitem>
  * </itemizedlist>
+ *
+ * Last reviewed on 2006-09-15 (0.10.10)
  */
 
 #ifdef HAVE_CONFIG_H