element: Improve gst_element_get_name() docs

Fixes bug #621660.
This commit is contained in:
Benjamin Gaignard 2010-06-15 18:48:53 +02:00 committed by Sebastian Dröge
parent f10f4f1632
commit 5d44b1a381

View file

@ -679,9 +679,15 @@ GType gst_element_get_type (void);
/** /**
* gst_element_get_name: * 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)) #define gst_element_get_name(elem) gst_object_get_name(GST_OBJECT_CAST(elem))