moved docs to sgml files added first batch of docs provided by ronald

[platform/upstream/gstreamer.git] / docs / gst / tmpl / gstelement.sgml

diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml
index ee370e9..fe5f2b3 100644 (file)
--- a/docs/gst/tmpl/gstelement.sgml
+++ b/docs/gst/tmpl/gstelement.sgml
@@ -343,13 +343,15 @@ Get the pads of this elements.
 
 <!-- ##### MACRO GST_ELEMENT_ERROR ##### -->
 <para>
-
+Utility function that elements can use in case they encountered a fatal
+data processing error. The pipeline will throw an error signal and the
+application will be requested to stop further media processing.
 </para>
 
-@el: 
+@el: the element that throws the error
 @domain: 
 @code: 
-@message: 
+@message: the message to display
 @debug: