X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=gst%2Fgsterror.c;h=820b51e0e78e50dcb913179e0e0496aa74a03cc2;hb=ce43de86902c4e9c8ed4e9682602664cb9bce2ee;hp=0cf5285daa735dced86486960ef1551301298e98;hpb=e10266e3f3cf9b05b69198b1ac6faa9a62840e30;p=platform%2Fupstream%2Fgstreamer.git
diff --git a/gst/gsterror.c b/gst/gsterror.c
index 0cf5285..820b51e 100644
--- a/gst/gsterror.c
+++ b/gst/gsterror.c
@@ -19,6 +19,7 @@
/**
* SECTION:gsterror
+ * @title: GstError
* @short_description: Categorized error messages
* @see_also: #GstMessage
*
@@ -66,43 +67,42 @@
*
* Elements throw errors using the #GST_ELEMENT_ERROR convenience macro:
*
- *
- * Throwing an error
- *
+ * ## Throwing an error
+ *
+ * |[
* GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
* (_("No file name specified for reading.")), (NULL));
- *
- *
+ * ]|
*
* Things to keep in mind:
- *
- * Don't go off inventing new error codes. The ones
+ *
+ * * Don't go off inventing new error codes. The ones
* currently provided should be enough. If you find your type of error
- * does not fit the current codes, you should use FAILED.
- * Don't provide a message if the default one suffices.
+ * does not fit the current codes, you should use FAILED.
+ * * Don't provide a message if the default one suffices.
* this keeps messages more uniform. Use (%NULL) - not forgetting the
- * parentheses.
- * If you do supply a custom message, it should be
+ * parentheses.
+ * * If you do supply a custom message, it should be
* marked for translation. The message should start with a capital
* and end with a period. The message should describe the error in short,
* in a human-readable form, and without any complex technical terms.
* A user interface will present this message as the first thing a user
* sees. Details, technical info, ... should go in the debug string.
- *
- * The debug string can be as you like. Again, use (%NULL)
+ *
+ * * The debug string can be as you like. Again, use (%NULL)
* if there's nothing to add - file and line number will still be
* passed. #GST_ERROR_SYSTEM can be used as a shortcut to give
- * debug information on a system call error.
- *
+ * debug information on a system call error.
+ *
*/
-/* FIXME 0.11: the entire error system needs an overhaul - it's not very
+/* FIXME 2.0: the entire error system needs an overhaul - it's not very
* useful the way it is. Also, we need to be able to specify additional
* 'details' for errors (e.g. disk/file/resource error -> out-of-space; or
* put the url/filename/device name that caused the error somewhere)
* without having to add enums for every little thing.
*
- * FIXME 0.11: get rid of GST_{CORE,LIBRARY,RESOURCE,STREAM}_ERROR_NUM_ERRORS.
+ * FIXME 2.0: get rid of GST_{CORE,LIBRARY,RESOURCE,STREAM}_ERROR_NUM_ERRORS.
* Maybe also replace _quark() functions with g_quark_from_static_string()?
*/
#ifdef HAVE_CONFIG_H