fix GOption context leaks doc fixes

[platform/upstream/gstreamer.git] / gst / gsterror.h

diff --git a/gst/gsterror.h b/gst/gsterror.h
index be0d7e5..e22c35d 100644 (file)
--- a/gst/gsterror.h
+++ b/gst/gsterror.h
@@ -185,14 +185,46 @@ typedef enum
   GST_STREAM_ERROR_NUM_ERRORS
 } GstStreamError;
 
-/* This should go away once we convinced glib people to register GError */
 #define GST_TYPE_G_ERROR    (gst_g_error_get_type ())
 
+/**
+ * GST_LIBRARY_ERROR:
+ *
+ * Error domain for library loading. Errors in this domain will
+ * be from the #GstLibraryError enumeration.
+ * See #GError for information on error domains.
+ */
 #define GST_LIBRARY_ERROR   gst_library_error_quark ()
+/**
+ * GST_RESOURCE_ERROR:
+ *
+ * Error domain for resource handling. Errors in this domain will
+ * be from the #GstResourceError enumeration.
+ * See #GError for information on error domains.
+ */
 #define GST_RESOURCE_ERROR  gst_resource_error_quark ()
+/**
+ * GST_CORE_ERROR:
+ *
+ * Error domain for core system. Errors in this domain will
+ * be from the #GstCoreError enumeration.
+ * See #GError for information on error domains.
+ */
 #define GST_CORE_ERROR      gst_core_error_quark ()
+/**
+ * GST_STREAM_ERROR:
+ *
+ * Error domain for media stream processing. Errors in this domain will
+ * be from the #GstStreamError enumeration.
+ * See #GError for information on error domains.
+ */
 #define GST_STREAM_ERROR    gst_stream_error_quark ()
 
+/**
+ * GST_ERROR_SYSTEM:
+ *
+ * Generates an human readable error message out of an errno number.
+ */
 #define GST_ERROR_SYSTEM    ("system error: %s", g_strerror (errno))
 
 GType gst_g_error_get_type (void);