added params for deprecation guards documented some more enums

Original commit message from CVS:
added params for deprecation guards
documented some more enums

diff --git a/ChangeLog b/ChangeLog
index 7cec6bd..ac033e5 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+2005-01-21  Stefan Kost  <ensonic@users.sf.net>
+
+       * docs/gst/Makefile.am:
+       * docs/libs/Makefile.am:
+      added params for deprecation guards
+       * gst/gst.c:
+       * gst/gst.h:
+       * gst/gsterror.c: (_gst_resource_errors_init),
+       (_gst_stream_errors_init):
+       * gst/gsterror.h:
+      documented some more enums
+
 2005-01-19  Jan Schmidt  <thaytan@mad.scientist.com>
        * gst/autoplug/gstspideridentity.c:
        Cosmetic fix - spider_find_peek should be static

diff --git a/docs/gst/Makefile.am b/docs/gst/Makefile.am
index cb87136..21e5089 100644 (file)
--- a/docs/gst/Makefile.am
+++ b/docs/gst/Makefile.am
@@ -39,7 +39,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
 DOC_SOURCE_DIR=$(top_srcdir)/gst
 
 # Extra options to supply to gtkdoc-scan.
-SCAN_OPTIONS=
+SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
 
 # Extra options to supply to gtkdoc-mkdb.
 MKDB_OPTIONS=--sgml-mode --ignore-files=parse

diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
index 33857f6..a5743e3 100644 (file)
--- a/docs/libs/Makefile.am
+++ b/docs/libs/Makefile.am
@@ -39,7 +39,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
 DOC_SOURCE_DIR=$(top_srcdir)/libs/gst
 
 # Extra options to supply to gtkdoc-scan.
-SCAN_OPTIONS=
+SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
 
 # FIXME :
 # there's something wrong with gstreamer-sections.txt not being in the dist

diff --git a/gst/gst.c b/gst/gst.c
index 96e0955..7f8f95d 100644 (file)
--- a/gst/gst.c
+++ b/gst/gst.c
@@ -818,8 +818,9 @@ init_popt_callback (poptContext context, enum poptCallbackReason reason,
  * gst_use_threads:
  * @use_threads: a #gboolean indicating whether threads should be used
  *
- * This function is deprecated and should not be used in new code.
- * GStreamer requires threads to be enabled at all times.
+ * Does nothing anymore. GStreamer requires threads to be enabled at all times.
+ *
+ * Deprecated: This function is deprecated and should not be used in new code.
  */
 void
 gst_use_threads (gboolean use_threads)
@@ -829,11 +830,10 @@ gst_use_threads (gboolean use_threads)
 /**
  * gst_has_threads:
  *
- * This function is deprecated and should not be used in new code.
- *
  * Queries if GStreamer has threads enabled.
  *
  * Returns: %TRUE if threads are enabled.
+ * Deprecated: This function is deprecated and should not be used in new code.
  */
 gboolean
 gst_has_threads (void)

diff --git a/gst/gst.h b/gst/gst.h
index bbe8344..2f25b2e 100644 (file)
--- a/gst/gst.h
+++ b/gst/gst.h
@@ -95,8 +95,10 @@ gboolean     gst_init_check_with_popt_table  (int *argc, char **argv[],
 
 const GstPoptOption *  gst_init_get_popt_table         (void);
 
+#ifndef GST_DISABLE_DEPRECATED
 void           gst_use_threads                 (gboolean use_threads);
 gboolean       gst_has_threads                 (void);
+#endif
 
 void           gst_main                        (void);
 void           gst_main_quit                   (void);

diff --git a/gst/gsterror.c b/gst/gsterror.c
index a8acb6b..72364e6 100644 (file)
--- a/gst/gsterror.c
+++ b/gst/gsterror.c
@@ -110,7 +110,7 @@ _gst_resource_errors_init (void)
   t = g_new0 (gchar *, GST_RESOURCE_ERROR_NUM_ERRORS);
 
   TABLE (t, RESOURCE, FAILED,
-      N_("GStreamer encountered a general supporting library error."));
+      N_("GStreamer encountered a general resource error."));
   TABLE (t, RESOURCE, TOO_LAZY,
       N_("GStreamer developers were too lazy to assign an error code "
           "to this error.  Please file a bug."));
@@ -140,7 +140,7 @@ _gst_stream_errors_init (void)
   t = g_new0 (gchar *, GST_STREAM_ERROR_NUM_ERRORS);
 
   TABLE (t, STREAM, FAILED,
-      N_("GStreamer encountered a general supporting library error."));
+      N_("GStreamer encountered a general stream error."));
   TABLE (t, STREAM, TOO_LAZY,
       N_("GStreamer developers were too lazy to assign an error code "
           "to this error.  Please file a bug."));

diff --git a/gst/gsterror.h b/gst/gsterror.h
index 7a18cfa..d2bb659 100644 (file)
--- a/gst/gsterror.h
+++ b/gst/gsterror.h
@@ -36,19 +36,19 @@ G_BEGIN_DECLS
  */
 /**
  * GstCoreError:
- * @GST_CORE_ERROR_FAILED:
- * @GST_CORE_ERROR_TOO_LAZY:
- * @GST_CORE_ERROR_NOT_IMPLEMENTED:
- * @GST_CORE_ERROR_STATE_CHANGE:
- * @GST_CORE_ERROR_PAD:
- * @GST_CORE_ERROR_THREAD:
- * @GST_CORE_ERROR_SCHEDULER:
- * @GST_CORE_ERROR_NEGOTIATION:
- * @GST_CORE_ERROR_EVENT:
- * @GST_CORE_ERROR_SEEK:
- * @GST_CORE_ERROR_CAPS:
- * @GST_CORE_ERROR_TAG:
- * @GST_CORE_ERROR_NUM_ERRORS:
+ * @GST_CORE_ERROR_FAILED: GStreamer encountered a general core library error.
+ * @GST_CORE_ERROR_TOO_LAZY: GStreamer developers were too lazy to assign an error code to this error.  Please file a bug.
+ * @GST_CORE_ERROR_NOT_IMPLEMENTED: Internal GStreamer error: code not implemented.  File a bug.
+ * @GST_CORE_ERROR_STATE_CHANGE: Internal GStreamer error: state change failed.  File a bug.
+ * @GST_CORE_ERROR_PAD: Internal GStreamer error: pad problem.  File a bug.
+ * @GST_CORE_ERROR_THREAD: Internal GStreamer error: thread problem.  File a bug.
+ * @GST_CORE_ERROR_SCHEDULER: Internal GStreamer error: scheduler problem.  File a bug.
+ * @GST_CORE_ERROR_NEGOTIATION: Internal GStreamer error: negotiation problem.  File a bug.
+ * @GST_CORE_ERROR_EVENT: Internal GStreamer error: event problem.  File a bug.
+ * @GST_CORE_ERROR_SEEK: Internal GStreamer error: seek problem.  File a bug.
+ * @GST_CORE_ERROR_CAPS: Internal GStreamer error: caps problem.  File a bug.
+ * @GST_CORE_ERROR_TAG: Internal GStreamer error: tag problem.  File a bug.
+ * @GST_CORE_ERROR_NUM_ERRORS: the error count
  *
  * Core errors are anything that can go wrong in or using
  * the core GStreamer library
@@ -74,13 +74,13 @@ typedef enum
 
 /**
  * GstLibraryError:
- * @GST_LIBRARY_ERROR_FAILED:
- * @GST_LIBRARY_ERROR_TOO_LAZY:
- * @GST_LIBRARY_ERROR_INIT:
- * @GST_LIBRARY_ERROR_SHUTDOWN:
- * @GST_LIBRARY_ERROR_SETTINGS:
+ * @GST_LIBRARY_ERROR_FAILED: GStreamer encountered a general supporting library error.
+ * @GST_LIBRARY_ERROR_TOO_LAZY: GStreamer developers were too lazy to assign an error code to this error.  Please file a bug.
+ * @GST_LIBRARY_ERROR_INIT: Could not initialize supporting library.
+ * @GST_LIBRARY_ERROR_SHUTDOWN: Could not close supporting library.
+ * @GST_LIBRARY_ERROR_SETTINGS: Could not close supporting library.
  * @GST_LIBRARY_ERROR_ENCODE:
- * @GST_LIBRARY_ERROR_NUM_ERRORS:
+ * @GST_LIBRARY_ERROR_NUM_ERRORS: the error count
  *
  * Library errors are for errors from the library being used by elements
  * initializing, closing, ...
@@ -98,20 +98,20 @@ typedef enum
 
 /**
  * GstResourceError:
- * @GST_RESOURCE_ERROR_FAILED:
- * @GST_RESOURCE_ERROR_TOO_LAZY:
- * @GST_RESOURCE_ERROR_NOT_FOUND:
- * @GST_RESOURCE_ERROR_BUSY:
- * @GST_RESOURCE_ERROR_OPEN_READ:
- * @GST_RESOURCE_ERROR_OPEN_WRITE:
- * @GST_RESOURCE_ERROR_OPEN_READ_WRITE:
- * @GST_RESOURCE_ERROR_CLOSE:
- * @GST_RESOURCE_ERROR_READ:
- * @GST_RESOURCE_ERROR_WRITE:
- * @GST_RESOURCE_ERROR_SEEK:
- * @GST_RESOURCE_ERROR_SYNC:
- * @GST_RESOURCE_ERROR_SETTINGS:
- * @GST_RESOURCE_ERROR_NUM_ERRORS:
+ * @GST_RESOURCE_ERROR_FAILED: GStreamer encountered a general resource error
+ * @GST_RESOURCE_ERROR_TOO_LAZY: GStreamer developers were too lazy to assign an error code to this error.  Please file a bug.
+ * @GST_RESOURCE_ERROR_NOT_FOUND: Resource not found
+ * @GST_RESOURCE_ERROR_BUSY: Resource busy or not available
+ * @GST_RESOURCE_ERROR_OPEN_READ: Could not open resource for reading
+ * @GST_RESOURCE_ERROR_OPEN_WRITE: Could not open resource for writing
+ * @GST_RESOURCE_ERROR_OPEN_READ_WRITE: Could not open resource for reading and writing
+ * @GST_RESOURCE_ERROR_CLOSE: Could not close resource
+ * @GST_RESOURCE_ERROR_READ: Could not read from resource
+ * @GST_RESOURCE_ERROR_WRITE: Could not write to resource
+ * @GST_RESOURCE_ERROR_SEEK: Could not perform seek on resource
+ * @GST_RESOURCE_ERROR_SYNC: Could not synchronize on resource
+ * @GST_RESOURCE_ERROR_SETTINGS: Could not get/set settings from/on resource
+ * @GST_RESOURCE_ERROR_NUM_ERRORS: the error count
  *
  * Resource errors are for anything external used by an element:
  * memory, files, network connections, process space, ...
@@ -137,18 +137,18 @@ typedef enum
 
 /**
  * GstStreamError:
- * @GST_STREAM_ERROR_FAILED:
- * @GST_STREAM_ERROR_TOO_LAZY:
- * @GST_STREAM_ERROR_NOT_IMPLEMENTED:
- * @GST_STREAM_ERROR_TYPE_NOT_FOUND:
- * @GST_STREAM_ERROR_WRONG_TYPE:
- * @GST_STREAM_ERROR_CODEC_NOT_FOUND:
- * @GST_STREAM_ERROR_DECODE:
- * @GST_STREAM_ERROR_ENCODE:
- * @GST_STREAM_ERROR_DEMUX:
- * @GST_STREAM_ERROR_MUX:
- * @GST_STREAM_ERROR_FORMAT:
- * @GST_STREAM_ERROR_NUM_ERRORS:
+ * @GST_STREAM_ERROR_FAILED: GStreamer encountered a general stream error
+ * @GST_STREAM_ERROR_TOO_LAZY: GStreamer developers were too lazy to assign an error code to this error.  Please file a bug
+ * @GST_STREAM_ERROR_NOT_IMPLEMENTED: Element doesn't implement handling of this stream. Please file a bug.
+ * @GST_STREAM_ERROR_TYPE_NOT_FOUND: Could not determine type of stream
+ * @GST_STREAM_ERROR_WRONG_TYPE: The stream is of a different type than handled by this element
+ * @GST_STREAM_ERROR_CODEC_NOT_FOUND: There is no codec present that can handle the stream's type
+ * @GST_STREAM_ERROR_DECODE: Could not decode stream
+ * @GST_STREAM_ERROR_ENCODE: Could not encode stream
+ * @GST_STREAM_ERROR_DEMUX: Could not demultiplex stream
+ * @GST_STREAM_ERROR_MUX: Could not multiplex stream
+ * @GST_STREAM_ERROR_FORMAT: Stream is of the wrong format
+ * @GST_STREAM_ERROR_NUM_ERRORS: the error count
  *
  * Stream errors are for anything related to the stream being processed:
  * format errors, media type errors, ...