[gst-cvs] gst-plugins-base: docs: improve gst_discoverer_new() docs a bit

[Tim Müller]

Module: gst-plugins-base
Branch: master
Commit: beae0db284318ce3eda503a1b42ba8bedaabcad3
URL:    http://cgit.freedesktop.org/gstreamer/gst-plugins-base/commit/?id=beae0db284318ce3eda503a1b42ba8bedaabcad3

Author: Tim-Philipp Müller <tim.muller at collabora.co.uk>
Date:   Fri Oct 15 17:23:44 2010 +0100

docs: improve gst_discoverer_new() docs a bit

---

 gst-libs/gst/pbutils/gstdiscoverer.c |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/gst-libs/gst/pbutils/gstdiscoverer.c b/gst-libs/gst/pbutils/gstdiscoverer.c
index 5d1ba25..eb04f3a 100644
--- a/gst-libs/gst/pbutils/gstdiscoverer.c
+++ b/gst-libs/gst/pbutils/gstdiscoverer.c
@@ -1362,14 +1362,16 @@ gst_discoverer_discover_uri (GstDiscoverer * discoverer, const gchar * uri,
 
 /**
  * gst_discoverer_new:
- * @timeout: The timeout to set on the discoverer
+ * @timeout: timeout per file, in nanoseconds. Allowed are values between
+ *     one second (#GST_SECOND) and one hour (3600 * #GST_SECOND)
  * @err: a pointer to a #GError. can be %NULL
  *
  * Creates a new #GstDiscoverer with the provided timeout.
  *
  * Returns: The new #GstDiscoverer. Free with gst_object_unref() when done.
- * If an error happened when creating the discoverer, @err will be set accordingly
- * and %NULL will be returned.
+ * If an error happened when creating the discoverer, @err will be set
+ * accordingly and %NULL will be returned. If @err is set, the caller must
+ * free it when no longer needed using g_error_free().
  * 
  * Since: 0.10.31
  */