From beae0db284318ce3eda503a1b42ba8bedaabcad3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim-Philipp=20M=C3=BCller?= Date: Fri, 15 Oct 2010 17:23:44 +0100 Subject: [PATCH] docs: improve gst_discoverer_new() docs a bit --- gst-libs/gst/pbutils/gstdiscoverer.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/gst-libs/gst/pbutils/gstdiscoverer.c b/gst-libs/gst/pbutils/gstdiscoverer.c index 5d1ba25971..eb04f3a9fd 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 */