From 5d44b1a3814bc9f7804d03a23d84fcf6b65f623a Mon Sep 17 00:00:00 2001 From: Benjamin Gaignard Date: Tue, 15 Jun 2010 18:48:53 +0200 Subject: [PATCH] element: Improve gst_element_get_name() docs Fixes bug #621660. --- gst/gstelement.h | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/gst/gstelement.h b/gst/gstelement.h index 81598dcb1f..6795f552d8 100644 --- a/gst/gstelement.h +++ b/gst/gstelement.h @@ -679,9 +679,15 @@ GType gst_element_get_type (void); /** * gst_element_get_name: - * @elem: a #GstElement to set the name of. + * @elem: a #GstElement to get the name of @elem. + * + * Returns a copy of the name of @elem. + * Caller should g_free() the return value after usage. + * For a nameless element, this returns NULL, which you can safely g_free() + * as well. + * + * Returns: the name of @elem. g_free() after usage. MT safe. * - * Gets the name of the element. */ #define gst_element_get_name(elem) gst_object_get_name(GST_OBJECT_CAST(elem))